garden 0.0.15.pre → 0.0.16.pre

data/README.textile

@@ -0,0 +1,32 @@
+A utility for using different seed formats in your ActiveRecord database.
+
+In process. Currently supports:
+
+Excel spreadsheet format:
+
+Garden.excel 'spreadsheetname'
+
+CSV spreadsheet format:
+
+Garden.csv 'spreadsheetname'
+
+Common options:
+
+:reference >> The column name to use as a reference for updating values.
+
+:validate >> [Boolean][default=true] >> Whether to perform validations on ActiveRecord::Base instances
+
+:only >> (Excel only) whitelist the worksheet names to seed
+:worksheet >> (Excel only) whitelist the single worksheet name to seed
+
+:table >> (CSV only) the table name to seed into (defaults to an interpretation based on the csv filename)
+
+Callbacks:
+  Callbacks allow for methods and actions to be injected in the process of the seeding of data. The most common callbacks are those
+  that will be called on each instance that is created by the seed process.
+  
+  :before_validation
+    If option is a method or Proc instance, it will be called with the record as the first argument.
+    If option is a symbol, Garden expects it refers to the name of a method for that instance and will call it on the record.
+
+

data/lib/garden.rb

@@ -6,6 +6,7 @@ module Garden
   autoload :Spreadsheets
   autoload :Mediators
   autoload :Helpers
+  autoload :Models
   autoload :Instance
   
   # def self.plant 

data/lib/garden/instance.rb

@@ -47,8 +47,9 @@ module Garden
     include Columns
     
     def initialize(clazz, attributes=nil, options={})
-      @options = options.dup
-      
+      @options = options.dup.symbolize_keys
+      # initialize_callbacks
+
       if @options.has_key? :reference
         @reference_column = @options.delete(:reference).to_sym
         @reference = attributes.delete @reference_column
@@ -65,6 +66,17 @@ module Garden
       assign_attributes attributes if attributes
     end
     
+    # def initialize_callbacks
+    #   for name in active_record_callbacks do
+    #     
+    #     
+    #     
+    #   end
+    #   
+    #   @callbacks = {}
+    #   @callbacks[:before_validation] = @options.delete(:before_validation) if @options.has_key?(:before_validation)
+    # end
+    
     def assign_attributes(attributes)
       
       attributes.each do |key, value|
@@ -72,16 +84,16 @@ module Garden
         map_attribute key, value
       end
       
-      if @object.valid?
-        @object.save!
-        
+      # execute_callback(:before_validation)
+      
+      if @object.save(:validate => @options[:validate])
         if @reference.nil?
           puts ". Saved new instance: #{@clazz} #{@object.to_param}"
         else
           puts ". Saved existing instance: #{@clazz} #{@object.to_param}"
         end
       else
-        puts "! Invalid instance: #{@object.to_param}"
+        puts "! Instance was not saved: #{@object.to_param}"
         # puts "#{@name}:"
         # puts " - Valid attributes: #{attributes.keys}"
         # puts " - Excel sheet keys: #{all_keys}"
@@ -91,7 +103,9 @@ module Garden
         # @object.errors.each do |error|
         #   puts "Error => #{error}: #{@object.errors.get error}"
         # end
-        puts @object.errors.to_a
+        if @object.errors.any?
+          puts @object.errors.to_a 
+        end
         puts "."
       end
       
@@ -152,7 +166,7 @@ module Garden
           # build the association if it hasn't already been built.
           @object.send("build_#{assoc}".to_sym)
         end
-        eval "@object.#{key} = '#{value.gsub(/[']/, '\\\\\'')}'"
+        eval "@object.#{key} = '#{value.to_s.gsub(/[']/, '\\\\\'')}'"
         return
       end
       
@@ -195,6 +209,34 @@ module Garden
       
     end
     
+    # def execute_callback name
+    #   name = name.to_sym
+    #   callback = @callbacks[name]
+    #   
+    #   if callback
+    #     
+    #     if active_record_callbacks.include?(name)
+    #       # Execute a callback by applying it to the ActiveRecord model.
+    #       
+    #     else
+    #       
+    #     end
+    #     
+    #     # puts "Executing callback: #{name}, #{callback}, #{callback.class}"
+    #     case callback
+    #     when Proc, Method then callback.call(@object)
+    #     when Symbol, String then record.send(callback.to_sym)
+    #     end
+    #   end
+    # end
+    # 
+    # private
+    
+    # def _execute_active_record_callback name, callback
+    #   
+    # end
+    
+    
   end
   
   Instance.send :include, Helpers::RealInstance

data/lib/garden/mediators.rb

@@ -2,72 +2,35 @@ module Garden
   module Mediators
     class Table
       
-      # def self.parse_table_name namish
-      #   namish.parameterize.underscore
-      # end
-      
-      def self.find_model_class namish
-        clazz = nil
-        namish = namish.singularize
+      def initialize namish, options={}
+        @instance_options = options.reverse_merge!({:validate => true})
         
-        begin
-          # try the format as it should be. Camelcase, and with :: or / for modules
-          # Module::Classname
-          clazz = namish.underscore.classify.constantize
-        rescue
-          begin
-            # try the format "Class Name" by turning spaced words into camelcase
-            clazz = namish.parameterize.underscore.classify.constantize
-          rescue
-            begin
-              # try the format "Class Name" by turning spaced words into module separators
-              clazz = namish.gsub(/ /, "/").underscore.classify.constantize
-            rescue
-              puts "Nope"
-            end
-          end
-        end
-        clazz
-      end
-      
-      def initialize namish
-        @instance_options ||= {}
+        # puts "Instance options: #{@instance_options}"
         
-        @clazz = Table.find_model_class namish
+        @clazz = Models.find namish, @instance_options
         
         if @clazz.nil? || !@clazz.new.is_a?(ActiveRecord::Base)
           puts "!! Class '#{namish}' could not be parsed to an ActiveRecord subclass."
         end
         
-        # Get the ActiveRecord model from the tablename.
-        # begin
-        #   @clazz = @name.classify.constantize
-        #   raise "Class #{@clazz.to_s} is not an ActiveRecord subclass." unless @clazz.new.is_a?(ActiveRecord::Base)
-        # rescue Exception => e
-        #   puts " ** Could not derive ActiveRecord model from the provided name: #{namish}. Exception: #{e.message}"
-        # end
-        
-        # @instance = @clazz.new
-        
       end
       
       def valid?
         @clazz != nil
       end
-    
-      # def parse_headers array
-      #   # @headers = array.map { |header| header.to_s.parameterize.underscore }
-      #   @headers = array.map { |header| header.to_s.strip.gsub(/ /, '-').underscore }
-      # end
       
       def reference_by col_name
         @instance_options[:reference] = col_name
       end
       
-      # def relationships
-      #   @relationships
-      # end
-      # 
+      def validate=(val)
+        @instance_options[:validate] = val
+      end
+
+      def validate
+        @instance_options[:validate]
+      end
+      
       def row attributes
         Instance.new @clazz, attributes, @instance_options.dup
       end
@@ -79,7 +42,7 @@ module Garden
           false
         end
       end
-      
+   
     end
   end
 end

data/lib/garden/models.rb

@@ -0,0 +1,77 @@
+module Garden
+  class Models
+    
+    CALLBACKS = ActiveRecord::Callbacks::CALLBACKS
+    
+    
+    def self.find namish, options={}
+      
+      # We return the found class if we've already found it.
+      @@found ||= {}
+      return @@found[namish.to_s] if @@found.has_key?(namish.to_s)
+      
+      clazz = nil
+      namish = namish.singularize
+      
+      begin
+        # try the format as it should be. Camelcase, and with :: or / for modules
+        # Module::Classname
+        clazz = namish.underscore.classify.constantize
+      rescue
+        begin
+          # try the format "Class Name" by turning spaced words into camelcase
+          clazz = namish.parameterize.underscore.classify.constantize
+        rescue
+          begin
+            # try the format "Class Name" by turning spaced words into module separators
+            clazz = namish.gsub(/ /, "/").underscore.classify.constantize
+          rescue
+            puts "Nope"
+          end
+        end
+      end
+      
+      if clazz
+        apply_callbacks clazz, options
+        @@found[namish.to_s] = clazz
+      end
+      clazz
+      
+    end
+    
+    def self.apply_callbacks clazz, callbacks
+      @@created_callbacks ||= []
+      
+      for name in CALLBACKS do
+        if callbacks.has_key?(name)
+          callback = callbacks[name]
+          
+          # Will add a callback to the ActiveRecord model 
+          clazz.send name, Proc.new{ |record| Garden::Models.execute_callback(record, callback) }
+          
+          # Retain a reference to the created callback so we can remove it later 
+          key = name.to_s.gsub(/^(before|after|around)_/, '')
+          list_name = "_#{key}_callbacks"
+          callback_name = clazz.send(list_name).last.filter
+          
+          @@created_callbacks << { :class => clazz, :list => list_name, :callback => callback_name }
+        end
+      end
+
+    end
+    
+    def self.execute_callback record, callback
+      # puts "Executing callback on #{record.inspect}, #{callback}"
+      
+      case callback
+      when Proc then callback.call(record)
+      when Symbol, String then record.send(callback.to_sym)
+      end
+      
+    end
+    
+    
+
+  end
+end
+    

data/lib/garden/spreadsheets.rb

@@ -7,7 +7,8 @@ module Garden
     class AbstractSpreadsheet
       def initialize filepath, options={}
         options ||= {}
-        @options = options.reverse_merge! :some_option => "nevermind"
+        # @options = options.reverse_merge! {}
+        @options = options
         open filepath
       end
     
@@ -15,7 +16,12 @@ module Garden
       end
       
       def build_mediator name
-        @mediator = Mediators::Table.new name
+        validation = @options[:validate]
+        validation = true if validation.nil?
+        
+        @options[:validate] = true if @options[:validate].nil?
+        
+        @mediator = Mediators::Table.new name, @options#:validate => validation
         raise "Invalid mediator for table #{name}" unless @mediator.valid?
         @mediator.reference_by(@options[:reference]) if @options.has_key?(:reference)
         @mediator
@@ -33,7 +39,7 @@ module Garden
         
         excel_spreadsheet = ::Spreadsheet.open filepath
       
-        worksheet_names = @options[:only] || @options[:worksheet] || excel_spreadsheet.worksheets.collect { |table| table.name }
+        worksheet_names = @options.delete(:only) || @options.delete(:worksheet) || excel_spreadsheet.worksheets.collect { |table| table.name }
         worksheet_names = [worksheet_names] unless worksheet_names.is_a?(Enumerable)
 
         # Import the worksheets
@@ -50,12 +56,12 @@ module Garden
         # Expects the first row to be the headers.
         headers = rows.shift.map { |header| header.to_s.strip.gsub(/ /, '-').underscore }
         rows.each do |row|
-          attributes = parse_worksheet_row(headers, row)
+          attributes = parse_worksheet_attributes(headers, row)
           @mediator.row attributes
         end
       end
       
-      def parse_worksheet_row keys, values
+      def parse_worksheet_attributes keys, values
         h = {}
         keys.each_index do |index|
           key = keys[index].to_sym

data/lib/garden/version.rb

@@ -1,3 +1,3 @@
 module Garden
-  VERSION = "0.0.15.pre"
+  VERSION = "0.0.16.pre"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: garden
 version: !ruby/object:Gem::Version
-  version: 0.0.15.pre
+  version: 0.0.16.pre
   prerelease: 7
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-14 00:00:00.000000000Z
+date: 2011-12-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spreadsheet
-  requirement: &70211128028900 !ruby/object:Gem::Requirement
+  requirement: &70188181388160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70211128028900
+  version_requirements: *70188181388160
 description: ! 'Allows you to organize your seeds in different formats. Typical seeds.rb,
   yaml fixtures, and a variety of spreadsheet formats. '
 email:
@@ -32,7 +32,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- README.markdown
+- README.textile
 - Rakefile
 - garden.gemspec
 - lib/garden.rb
@@ -40,6 +40,7 @@ files:
 - lib/garden/helpers/real_instance.rb
 - lib/garden/instance.rb
 - lib/garden/mediators.rb
+- lib/garden/models.rb
 - lib/garden/spreadsheets.rb
 - lib/garden/version.rb
 homepage: ''

data/README.markdown

@@ -1,5 +0,0 @@
-A utility for using different seed formats in your ActiveRecord database.
-
-In process. Currently supports Excel spreadsheet format. 
-
-    Garden.excel 'spreadsheetname'