remote_partial 0.3.2 → 0.4.0

data/README.rdoc

@@ -35,6 +35,25 @@ passed to Nokogiri's search method, and can be either xpath or css format. See:
 
 http://nokogiri.org/tutorials/searching_a_xml_html_document.html
 
+If no criteria are specified, the whole page will be retrieved.
+
+== Output modifier
+
+A lambda can be passed into RemotePartial.define, and this will be called
+on the retrieved content before the partial file is generated.
+
+Note that the lambda must be passed in as a string so it can be stored in a
+serialized format. RemotePartial will convert the string into a lambda when it
+is needed.
+
+For example, to change all instances of 'foo' to 'bar' in the partial:
+
+    RemotePartial.define(
+      url: 'http://somewhere.com',
+      name: 'foo_bar',
+      output_modifier: '{|content| content.gsub(/foo/, "bar")}'
+    )
+
 == Adding remote partial content to a page
 
 To output the content of the remote partial 'ruby' to a rails view add this:

data/app/models/remote_partial/builder.rb

@@ -22,6 +22,7 @@ module RemotePartial
     def create_or_update_partial
       @partial = Partial.find(args['name']) || Partial.new(name: args['name'])
       track_change(args, 'url')
+      track_change(args, 'output_modifier')
       track_change(args, 'criteria')
       track_change(args, 'repeat_period', @partial.default_repeat_period)
 

data/app/models/remote_partial/partial.rb

@@ -9,7 +9,7 @@ module RemotePartial
     end
 
     def update_file
-      resource_manager.output_to output_file_name
+      resource_manager.output_to(output_file_name)
       update_stale_at
     end
 
@@ -22,7 +22,7 @@ module RemotePartial
     end
 
     def resource_manager
-      ResourceManager.new(url, criteria)
+      ResourceManager.new(url, criteria, &output_modifier_to_lambda)
     end
     
     def repeat_period
@@ -63,5 +63,9 @@ module RemotePartial
       "_#{name}.html.erb"
     end
 
+    def output_modifier_to_lambda
+      output_modifier? ? instance_eval("lambda #{output_modifier}") : nil
+    end
+
   end
 end

data/app/models/remote_partial/resource_manager.rb

@@ -3,7 +3,7 @@ require 'net/http'
 
 module RemotePartial
   class ResourceManager
-    attr_reader :url, :criteria
+    attr_reader :url, :criteria, :output_modifier
 
     def self.get_page(url)
       Nokogiri::HTML(get_raw(url))
@@ -24,17 +24,10 @@ module RemotePartial
       raise RemotePartialRetrivalError.new(url, exception)
     end
 
-    def initialize(url, criteria = nil)
+    def initialize(url, criteria = nil, &output_modifier)
       @url = url
       @criteria = criteria
-    end
-
-    def html
-      if criteria
-        self.class.get_page(@url).search(criteria).to_s
-      else
-        self.class.get_raw(@url).force_encoding('UTF-8')
-      end
+      @output_modifier = output_modifier
     end
 
     def output_to(path)
@@ -43,7 +36,20 @@ module RemotePartial
       File.write(path, html)
     end
 
+    def html
+      text = criteria ? get_part_of_page : get_whole_page
+      output_modifier ? output_modifier.call(text) : text
+    end
+
     private
+    def get_whole_page
+      self.class.get_raw(@url).force_encoding('UTF-8')
+    end
+
+    def get_part_of_page
+      self.class.get_page(@url).search(criteria).to_s
+    end
+
     def output_folder
       File.dirname(@path)
     end

data/app/models/remote_partial/yaml_store.rb

@@ -24,6 +24,10 @@ module RemotePartial
       new(item.merge(name: name)) if item
     end
 
+    def self.all
+      read.keys.collect{|name| find(name)}
+    end
+
     def self.count
       read.keys.length
     end

data/lib/remote_partial/version.rb

@@ -1,11 +1,16 @@
 module RemotePartial
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end
 
 # History
 # =======
 #
-# 0.3.1 Move location where db is stored in test environment
+# 0.4.0 Add facility to modify the partial file before it is saved
+# ----------------------------------------------------------------
+# A modification can now be made to the content retrieved from the
+# remote page, before it is saved as a partial.
+#
+# 0.3.2 Move location where db is stored in test environment
 # ----------------------------------------------------------
 # The yaml file created by the Partial model during tests, had been put into
 # test/fixtures, but this is the wrong place because this is not a fixture. In

data/test/dummy/app/views/remote_partials/_partial_with_mod.html.erb

@@ -0,0 +1 @@
+Hello