Changed yarddoc, added a gem 'redcarpet' to Gemfile, wrote annotation…

…s to dhcp_range, network

.yardoc/checksums

@@ -1,21 +1,21 @@
-app/models/network.rb 419b714724924f355c95d2d84d6a5744709e41d4
-app/models/dhcp_range.rb dccebe89c40c6121e206668fa94cecbe499b3365
-app/models/ip_address.rb b20a1a698e0c1ed01ecff3c6f0f4420ea072bdfb
+app/models/network.rb 6d272cab4623f495a729e8a0ea7ce0e6f2107f79
+app/models/dhcp_range.rb 6218a4ce0b918dd85d00959cd378cc7552228109
+app/models/ip_address.rb 660c6bf5428cb9a1ffae9acd19d58b91f211dfcd
 app/models/device_type.rb 8067cabf647cc02348bb98b09313c4d3c89c167d
-app/models/dns_ip_join.rb 41e93f8493bbfad7bf0eadb87f51fa515da3f977
+app/models/dns_ip_join.rb 908679eea739eb06e08f9c9f3cfbcc23761faaaa
 app/models/notification.rb 417132e236b9fddd18b113c7e04f53aa1280380e
-app/helpers/networks_helper.rb 415aa76eb3b4ebce27d5c91e4fd5c245bb732593
-app/models/dns_device_assoc.rb 7f731f4b3b2667f12417ce9306620c9d05bbc40c
-app/helpers/dhcp_ranges_helper.rb 925329e313488750ca4755358a09a1f95bd10294
+app/helpers/networks_helper.rb ef7960631cf58b781806b5fc887c44b3d462c8de
+app/models/dns_device_assoc.rb a7485a9ad2e1110899007de03b9406261eba85a0
+app/helpers/dhcp_ranges_helper.rb f64d840fd291b21ba3a8071fd9a6f2c169028520
 app/helpers/application_helper.rb c2673f798fb13a72e793a6f2e763f11b0818bcc3
 app/helpers/device_types_helper.rb 1c1aba18f4719840fa8644272acb5a044c840296
 app/helpers/ip_addresses_helper.rb ff47dbe5516f6f310fff07f9e85c4aed1e5df915
 app/helpers/notifications_helper.rb 2186faaf2119f151c42e8eac75df0e7d6625cb04
-app/controllers/networks_controller.rb 84668c7034ca6d80e404e5e125947283419d0955
+app/controllers/networks_controller.rb 43d70a73efbf5d5236fb2a78e05e2ead9cf7daf9
 app/helpers/dns_device_assocs_helper.rb 1c47a15de5f87a53258e706736e9a29f06eb0dda
-app/controllers/dhcp_ranges_controller.rb 8cc5c5b8a47ba86a7d766939b16c0be5ac389cca
-app/controllers/application_controller.rb 0cb73195186af5c602f9d3768e657fa72260a9fb
-app/controllers/device_types_controller.rb 8030b835d298ac7a63a43b7d14bb42324668b18e
-app/controllers/ip_addresses_controller.rb b016b9b5af673f372741be437fc1b92314bb05da
+app/controllers/dhcp_ranges_controller.rb f778131c81396a7f2a7f7b94358171359ae2bfa6
+app/controllers/application_controller.rb 939acf9017117990db4721097877af7f1803b6d5
+app/controllers/device_types_controller.rb dce8405505a0827ff35125a05013085ac9f4ae0d
+app/controllers/ip_addresses_controller.rb b30a97e084497d841d54a150e5143689457384a4
 app/controllers/notifications_controller.rb 74e1e44c281966eddb38b859a1da498a89e64bf3
-app/controllers/dns_device_assocs_controller.rb 645a86864adf461d008f0b32c2699f7f7be7d5fa
+app/controllers/dns_device_assocs_controller.rb 0af4ef26510c9d62e3258b5c1de2bce21819c0b3

Gemfile

@@ -10,6 +10,7 @@ gem 'faker'
 gem 'annotate'
 gem 'rails-erd'
 gem 'yard'
+gem 'redcarpet'
 
 # Gems used only for assets and not required
 # in production environments by default.

Gemfile.lock

@@ -93,6 +93,7 @@ GEM
     rb-readline (0.4.2)
     rdoc (3.12)
       json (~> 1.4)
+    redcarpet (2.2.2)
     ruby-graphviz (1.0.8)
     ruby-ip (0.9.1)
     sass (3.2.1)
@@ -130,6 +131,7 @@ DEPENDENCIES
   rails (= 3.2.8)
   rails-erd
   rb-readline
+  redcarpet
   ruby-ip
   sass-rails (~> 3.2.3)
   therubyracer

app/models/dhcp_range.rb

@@ -27,7 +27,7 @@ class DhcpRange < ActiveRecord::Base
 	def address_count
 		IP.parse(self.end_ip).to_i - IP.parse(self.start_ip).to_i + 1
 	end
-
+	#Converts DHCP range into the IP Address
 	def to_range
 		IP.parse(self.start_ip)..IP.parse(self.end_ip)
 	end

app/models/network.rb

@@ -37,7 +37,7 @@ def assignable? ip
 		!(self.ip_addresses.collect {|x| x.ip_str}.include? ip.to_s) &&
 		self.dhcp_ranges.delete_if {|x| !(x.to_range === ip)}.length == 0
 	end
-
+	#Protects the private parts	
 	def ip_v4=
 		raise "You can't set this.  It's read-only.  Asshole."
 	end
@@ -68,7 +68,7 @@ def netmask
 		addr = read_attribute(:netmask)
 		IP.new([(read_attribute(:ip_v4))?"v4":"v6",addr]).to_s
 	end
-
+	#Returns number of static IP Adresses of a subnet or a supernet
 	def num_static_ip
 		total = 0
 		if self.child_networks == [] #If subnet
@@ -78,7 +78,7 @@ def num_static_ip
 		end
 		total
 	end
-
+	#Returns number IP Addresses in DHCP Ranges for a subnet or a supernet
 	def num_dhcp_ranges
 		total = 0
 		if self.child_networks == [] #If subnet

doc/app/DhcpRange.html

@@ -80,6 +80,8 @@ <h3 class="section-header">Methods</h3>
 
     <li><a href="#method-i-start_ip-3D">#start_ip=</a>
 
+    <li><a href="#method-i-to_range">#to_range</a>
+
   </ul>
 </nav>
 
@@ -222,7 +224,7 @@ <h3 class="section-header">Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="end_ip-source">
-            <pre><span class="ruby-comment"># File app/models/dhcp_range.rb, line 51</span>
+            <pre><span class="ruby-comment"># File app/models/dhcp_range.rb, line 55</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">end_ip</span>
         <span class="ruby-identifier">addr</span> = <span class="ruby-identifier">read_attribute</span>(<span class="ruby-value">:end_ip</span>)
         <span class="ruby-constant">IP</span>.<span class="ruby-identifier">new</span>([(<span class="ruby-identifier">read_attribute</span>(<span class="ruby-value">:ip_v4</span>))<span class="ruby-operator">?</span><span class="ruby-string">&quot;v4&quot;</span><span class="ruby-operator">:</span><span class="ruby-string">&quot;v6&quot;</span>,<span class="ruby-identifier">addr</span>]).<span class="ruby-identifier">to_s</span>
@@ -253,7 +255,7 @@ <h3 class="section-header">Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="end_ip-3D-source">
-            <pre><span class="ruby-comment"># File app/models/dhcp_range.rb, line 45</span>
+            <pre><span class="ruby-comment"># File app/models/dhcp_range.rb, line 49</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">end_ip=</span> <span class="ruby-identifier">attr</span>
         <span class="ruby-identifier">ip</span> = <span class="ruby-constant">IP</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">attr</span>)
         <span class="ruby-identifier">write_attribute</span>(<span class="ruby-value">:end_ip</span>, <span class="ruby-identifier">ip</span>.<span class="ruby-identifier">to_hex</span>) <span class="ruby-keyword">unless</span> ((<span class="ruby-identifier">ip</span>.<span class="ruby-identifier">proto</span><span class="ruby-operator">==</span><span class="ruby-string">&quot;v4&quot;</span>)<span class="ruby-operator">!=</span><span class="ruby-identifier">read_attribute</span>(<span class="ruby-value">:ip_v4</span>)) 
@@ -284,7 +286,7 @@ <h3 class="section-header">Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="start_ip-source">
-            <pre><span class="ruby-comment"># File app/models/dhcp_range.rb, line 39</span>
+            <pre><span class="ruby-comment"># File app/models/dhcp_range.rb, line 43</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">start_ip</span>
         <span class="ruby-identifier">addr</span> = <span class="ruby-identifier">read_attribute</span>(<span class="ruby-value">:start_ip</span>)
         <span class="ruby-constant">IP</span>.<span class="ruby-identifier">new</span>([(<span class="ruby-identifier">read_attribute</span>(<span class="ruby-value">:ip_v4</span>))<span class="ruby-operator">?</span><span class="ruby-string">&quot;v4&quot;</span><span class="ruby-operator">:</span><span class="ruby-string">&quot;v6&quot;</span>,<span class="ruby-identifier">addr</span>]).<span class="ruby-identifier">to_s</span>
@@ -315,7 +317,7 @@ <h3 class="section-header">Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="start_ip-3D-source">
-            <pre><span class="ruby-comment"># File app/models/dhcp_range.rb, line 32</span>
+            <pre><span class="ruby-comment"># File app/models/dhcp_range.rb, line 36</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">start_ip=</span> <span class="ruby-identifier">attr</span>
         <span class="ruby-identifier">ip</span> = <span class="ruby-constant">IP</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">attr</span>)
         <span class="ruby-identifier">write_attribute</span>(<span class="ruby-value">:ip_v4</span>, (<span class="ruby-identifier">ip</span>.<span class="ruby-identifier">proto</span><span class="ruby-operator">==</span><span class="ruby-string">&quot;v4&quot;</span>))
@@ -331,6 +333,36 @@ <h3 class="section-header">Public Instance Methods</h3>
       </div><!-- start_ip-3D-method -->
 
 
+      <div id="method-i-to_range" class="method-detail ">
+
+        <div class="method-heading">
+          <span class="method-name">to_range</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="to_range-source">
+            <pre><span class="ruby-comment"># File app/models/dhcp_range.rb, line 31</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_range</span>
+        <span class="ruby-constant">IP</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">start_ip</span>)<span class="ruby-operator">..</span><span class="ruby-constant">IP</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">end_ip</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- to_range-source -->
+
+        </div>
+
+
+
+
+      </div><!-- to_range-method -->
+
+
     </section><!-- public-instance-method-details -->
 
   </section><!-- 5Buntitled-5D -->

doc/app/DnsDeviceAssocsController.html

@@ -208,15 +208,16 @@ <h3 class="section-header">Public Instance Methods</h3>
 
           <div class="method-source-code" id="autocomplete-source">
             <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 24</span>
-    <span class="ruby-keyword">def</span> <span class="ruby-identifier">autocomplete</span>
-            <span class="ruby-identifier">q</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:query</span>]
-            <span class="ruby-identifier">result</span> = <span class="ruby-constant">DnsDeviceAssoc</span>.<span class="ruby-identifier">where</span>(<span class="ruby-node">&quot;name LIKE \&quot;#{q}%\&quot;&quot;</span>);
-            <span class="ruby-identifier">resp_val</span> = {<span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">q</span>,<span class="ruby-value">:suggestions</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">name</span>},
-                    <span class="ruby-value">:data</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">id</span>}}  
-<span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span>
-  <span class="ruby-identifier">format</span>.<span class="ruby-identifier">json</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">json</span><span class="ruby-operator">:</span> <span class="ruby-identifier">resp_val</span> }
-<span class="ruby-keyword">end</span>
-    <span class="ruby-keyword">end</span></pre>
+        <span class="ruby-keyword">def</span> <span class="ruby-identifier">autocomplete</span>
+                <span class="ruby-identifier">q</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:query</span>]
+                <span class="ruby-identifier">result</span> = <span class="ruby-constant">DnsDeviceAssoc</span>.<span class="ruby-identifier">where</span>(<span class="ruby-node">&quot;name LIKE \&quot;#{q}%\&quot;&quot;</span>);
+<span class="ruby-comment">##              resp_val = {:query =&gt; q,:suggestions =&gt; result.collect {|x| x.name},</span>
+<span class="ruby-comment">#                       :data =&gt; result.collect {|x| x.id}} </span>
+                        <span class="ruby-identifier">resp_val</span> = <span class="ruby-identifier">result</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> [<span class="ruby-identifier">x</span>.<span class="ruby-identifier">name</span>,<span class="ruby-identifier">x</span>.<span class="ruby-identifier">id</span>]}
+    <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span>
+      <span class="ruby-identifier">format</span>.<span class="ruby-identifier">json</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">json</span><span class="ruby-operator">:</span> <span class="ruby-identifier">resp_val</span> }
+    <span class="ruby-keyword">end</span>
+        <span class="ruby-keyword">end</span></pre>
           </div><!-- autocomplete-source -->
 
         </div>
@@ -243,7 +244,7 @@ <h3 class="section-header">Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="create-source">
-            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 102</span>
+            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 103</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span>
   <span class="ruby-ivar">@dns_device_assoc</span> = <span class="ruby-constant">DnsDeviceAssoc</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:dns_device_assoc</span>])
 
@@ -283,7 +284,7 @@ <h3 class="section-header">Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="dataTable-source">
-            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 35</span>
+            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 36</span>
     <span class="ruby-keyword">def</span> <span class="ruby-identifier">dataTable</span>
             <span class="ruby-identifier">s</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:sSearch</span>]
             <span class="ruby-keyword">if</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">%r\d*\./</span>)
@@ -347,7 +348,7 @@ <h3 class="section-header">Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="destroy-source">
-            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 134</span>
+            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 135</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span>
   <span class="ruby-ivar">@dns_device_assoc</span> = <span class="ruby-constant">DnsDeviceAssoc</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>])
   <span class="ruby-ivar">@dns_device_assoc</span>.<span class="ruby-identifier">destroy</span>
@@ -383,7 +384,7 @@ <h3 class="section-header">Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="edit-source">
-            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 96</span>
+            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 97</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span>
   <span class="ruby-ivar">@dns_device_assoc</span> = <span class="ruby-constant">DnsDeviceAssoc</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>])
 <span class="ruby-keyword">end</span></pre>
@@ -448,7 +449,7 @@ <h3 class="section-header">Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 86</span>
+            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 87</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span>
   <span class="ruby-ivar">@dns_device_assoc</span> = <span class="ruby-constant">DnsDeviceAssoc</span>.<span class="ruby-identifier">new</span>
 
@@ -483,7 +484,7 @@ <h3 class="section-header">Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="show-source">
-            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 75</span>
+            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 76</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span>
   <span class="ruby-ivar">@dns_device_assoc</span> = <span class="ruby-constant">DnsDeviceAssoc</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>])
 
@@ -518,7 +519,7 @@ <h3 class="section-header">Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="update-source">
-            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 118</span>
+            <pre><span class="ruby-comment"># File app/controllers/dns_device_assocs_controller.rb, line 119</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span>
   <span class="ruby-ivar">@dns_device_assoc</span> = <span class="ruby-constant">DnsDeviceAssoc</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>])