Sign upLogin

timcolonel/rails_embed_editor

View on GitHub
Star
doc/RailsEmbedEditor/FileManager.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>

<html>
<head>
<meta charset="UTF-8">

<title>class RailsEmbedEditor::FileManager - RDoc Documentation</title>

<link href="../fonts.css" rel="stylesheet">
<link href="../rdoc.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../";
</script>

<script src="../js/jquery.js"></script>
<script src="../js/navigation.js"></script>
<script src="../js/search_index.js"></script>
<script src="../js/search.js"></script>
<script src="../js/searcher.js"></script>
<script src="../js/darkfish.js"></script>


<body id="top" role="document" class="class">
<nav role="navigation">
  <div id="project-navigation">
    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2>
    <a href="../index.html" rel="home">Home</a>
  </h2>

  <div id="table-of-contents-navigation">
    <a href="../table_of_contents.html#pages">Pages</a>
    <a href="../table_of_contents.html#classes">Classes</a>
    <a href="../table_of_contents.html#methods">Methods</a>
  </div>
</div>

    <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

  </div>

  

  <div id="class-metadata">
    
    <div id="parent-class-section" class="nav-section">
  <h3>Parent</h3>

  
  <p class="link"><a href="../Object.html">Object</a>
  
</div>

    
    
    <!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    
    <li ><a href="#method-c-from_around">::from_around</a>
    
    <li ><a href="#method-c-from_options">::from_options</a>
    
    <li ><a href="#method-c-new">::new</a>
    
    <li ><a href="#method-i-read_lines">#read_lines</a>
    
    <li ><a href="#method-i-read_text">#read_text</a>
    
    <li ><a href="#method-i-save_lines">#save_lines</a>
    
    <li ><a href="#method-i-save_text">#save_text</a>
    
  </ul>
</div>

  </div>
</nav>

<main role="main" aria-labelledby="class-RailsEmbedEditor::FileManager">
  <h1 id="class-RailsEmbedEditor::FileManager" class="class">
    class RailsEmbedEditor::FileManager
  </h1>

  <section class="description">
    
  </section>

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    

    
    <section class="attribute-method-details" class="method-section">
      <header>
        <h3>Attributes</h3>
      </header>

      
      <div id="attribute-i-first_line" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">first_line</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-last_line" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">last_line</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
    </section>
    

    
     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Public Class Methods</h3>
       </header>

    
      <div id="method-c-from_around" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">from_around</span><span
            class="method-args">(filename, line, radius=2)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="from_around-source">
            <pre><span class="ruby-comment"># File lib/rails_embed_editor/file_manager.rb, line 19</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">from_around</span>(<span class="ruby-identifier">filename</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">radius</span>=<span class="ruby-value">2</span>)
  <span class="ruby-identifier">first_line</span> = <span class="ruby-identifier">line</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">radius</span>
  <span class="ruby-identifier">last_line</span> = <span class="ruby-identifier">line</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">radius</span>
  <span class="ruby-constant">RailsEmbedEditor</span><span class="ruby-operator">::</span><span class="ruby-constant">FileManager</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">filename</span>, <span class="ruby-identifier">first_line</span>, <span class="ruby-identifier">last_line</span>)
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-c-from_options" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">from_options</span><span
            class="method-args">(filename, options)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="from_options-source">
            <pre><span class="ruby-comment"># File lib/rails_embed_editor/file_manager.rb, line 11</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">from_options</span>(<span class="ruby-identifier">filename</span>, <span class="ruby-identifier">options</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:first_line</span>].<span class="ruby-identifier">nil?</span>
    <span class="ruby-identifier">from_around</span>(<span class="ruby-identifier">filename</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:line</span>].<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:radius</span>].<span class="ruby-identifier">to_i</span>)
  <span class="ruby-keyword">else</span>
    <span class="ruby-constant">RailsEmbedEditor</span><span class="ruby-operator">::</span><span class="ruby-constant">FileManager</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">filename</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:first_line</span>].<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:last_line</span>].<span class="ruby-identifier">to_i</span>)
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-c-new" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">new</span><span
            class="method-args">(filename, first_line = nil, last_line=nil)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File lib/rails_embed_editor/file_manager.rb, line 5</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">filename</span>, <span class="ruby-identifier">first_line</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">last_line</span>=<span class="ruby-keyword">nil</span>)
  <span class="ruby-ivar">@filename</span> = <span class="ruby-identifier">filename</span>
  <span class="ruby-ivar">@first_line</span> = <span class="ruby-identifier">first_line</span>
  <span class="ruby-ivar">@last_line</span> = <span class="ruby-identifier">last_line</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
    </section>
  
     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Public Instance Methods</h3>
       </header>

    
      <div id="method-i-read_lines" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">read_lines</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="read_lines-source">
            <pre><span class="ruby-comment"># File lib/rails_embed_editor/file_manager.rb, line 25</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">read_lines</span>
  <span class="ruby-identifier">lines</span> = []
  <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@filename</span>, <span class="ruby-string">'r'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">lines</span> = <span class="ruby-identifier">f</span>.<span class="ruby-identifier">readlines</span>[<span class="ruby-ivar">@first_line</span><span class="ruby-operator">-</span><span class="ruby-value">1</span><span class="ruby-operator">...</span><span class="ruby-ivar">@last_line</span>]
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">lines</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-read_text" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">read_text</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="read_text-source">
            <pre><span class="ruby-comment"># File lib/rails_embed_editor/file_manager.rb, line 33</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">read_text</span>
  <span class="ruby-identifier">read_lines</span>.<span class="ruby-identifier">join</span>()
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-save_lines" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">save_lines</span><span
            class="method-args">(lines)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="save_lines-source">
            <pre><span class="ruby-comment"># File lib/rails_embed_editor/file_manager.rb, line 41</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">save_lines</span>(<span class="ruby-identifier">lines</span>)
  <span class="ruby-identifier">all_lines</span> = []
  <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@filename</span>, <span class="ruby-string">'r'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">all_lines</span> = <span class="ruby-identifier">f</span>.<span class="ruby-identifier">readlines</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">all_lines</span> = <span class="ruby-identifier">all_lines</span>[<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-ivar">@first_line</span><span class="ruby-operator">-</span><span class="ruby-value">1</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">lines</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">all_lines</span>[<span class="ruby-ivar">@last_line</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>]
  <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@filename</span>, <span class="ruby-string">'w'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">all_lines</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
      <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">line</span>)
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-save_text" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">save_text</span><span
            class="method-args">(text)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="save_text-source">
            <pre><span class="ruby-comment"># File lib/rails_embed_editor/file_manager.rb, line 37</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">save_text</span>(<span class="ruby-identifier">text</span>)
  <span class="ruby-identifier">save_lines</span>(<span class="ruby-identifier">text</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/\r?\n/</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-node">&quot;#{x}\n&quot;</span> })
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
    </section>
  
  </section>
</main>


<footer id="validator-badges" role="contentinfo">
  <p><a href="http://validator.w3.org/check/referer">Validate</a>
  <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.1.
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>