dibber 0.2.2 → 0.3.0

data/README.rdoc

@@ -19,11 +19,11 @@ Add this to your Gemfile:
 
     gem 'dibber'
 
-=== Examples
+=== Rails Examples
 
 You have a rails app with a Thing model, and you want to seed it with some 
 things. Thing instances have the attributes 'name', 'colour', 'size'.
-You have a YAML file '/db/seeds/things.yml' that looks like this:
+You have a YAML file 'db/seeds/things.yml' that looks like this:
 
     foo:
       colour: red
@@ -36,8 +36,7 @@ You have a YAML file '/db/seeds/things.yml' that looks like this:
 Add this to your 'db/seeds.rb'
 
     Seeder = Dibber::Seeder
-    Seeder.seeds_path = "#{Rails.root}/db/seeds"
-    Seeder.new(Thing, 'things.yml').build
+    Seeder.seed :thing
     puts Seeder.report
 
 Then run 'rake db:seed'
@@ -48,23 +47,56 @@ You'll then be able to do this:
 
     thing = Thing.find_by_name(:foo)
     thing.colour    ---> 'red'
+
+=== Outside Rails
+
+Dibber can be used outside of Rails, but in this case you will need to
+specify the location of the seed files.
+
+    Seeder.seeds_path = "some/path/to/seeds"
+
+You can also use this technique in Rails if you want to put your seed files
+in an alternative folder to 'db/seeds'
  
 == Report  
  
-Each time seeds.rb is run, Seeder will output a report detailing start and 
-end time, and a log of how the number of things has changed.
+Seeder.report outputs a report detailing start and end time, and a log of how
+the number of things has changed
 
 == Overwriting existing entries
 
-As of version 0.2.0, Seeder#build will not overwrite existing data unless 
-directed to do so. 
+Seeder#build will not overwrite existing data unless directed to do so. 
 
    thing.update_attribute(:colour, 'black')
-   Seeder.new(Thing, 'things.yml').build
+   Seeder.seed :thing
    thing.reload.colour  ----> 'black'
 
-   Seeder.new(Thing, 'things.yml', :overwrite => true).build
+   Seeder.seed(:thing, :overwrite => true).build
    thing.reload.colour  ----> 'red'
 
-Have a look at the lib/examples folder, for a more detailed guide to how 
-Dibber is used.
+
+== Using alternative class and field name mappings
+
+Seeder.seed calls Seeder#build to build the objects defined in the seed files.
+You can call the build method directly if your seed file names do not match
+the class name:
+
+    Seeder.new(Thing, 'other_things.yml').build
+
+== More examples
+
+Take a look at test/examples/seeds.rb for some more usage examples.
+
+If you clone this app, you can run this example at the project root:
+
+    ruby test/examples/seeds.rb
+
+There is also an example of process log usage:
+
+    ruby test/examples/process_logs.rb
+
+
+
+
+
+

data/Rakefile

@@ -15,5 +15,5 @@ Rake::RDocTask.new do |rdoc|
 end
 
 Rake::TestTask.new do |t|
-  t.test_files = FileList['test/**/*.rb']
+  t.test_files = FileList['test/**/*_test.rb']
 end

data/lib/dibber/process_log.rb

@@ -29,5 +29,9 @@ module Dibber
       return @report
     end
 
+    def exists?(name)
+      @log.keys.include?(name)
+    end
+
   end
 end

data/lib/dibber/seeder.rb

@@ -5,6 +5,13 @@ module Dibber
   class Seeder
     attr_accessor :klass, :file, :attribute_method, :name_method, :overwrite
 
+    def self.seed(name, args = {})
+      class_name = name.to_s.strip.classify
+      new_klass = (/\A\w+(::\w+)+\Z/ =~ class_name) ? eval(class_name) : Kernel.const_get(class_name)
+      new_file = "#{name.to_s.pluralize}.yml"
+      new(new_klass, new_file, args).build
+    end
+
     def self.process_log
       @process_log || start_process_log
     end
@@ -20,7 +27,10 @@ module Dibber
     end
 
     def self.monitor(klass)
-      process_log.start(klass.to_s.tableize.to_sym, "#{klass}.count")
+      log_name = klass.to_s.tableize.to_sym
+      unless process_log.exists?(log_name)
+        process_log.start(log_name, "#{klass}.count")
+      end
     end
 
     def self.objects_from(file)
@@ -28,15 +38,13 @@ module Dibber
     end
 
     def self.seeds_path
-      @seeds_path || raise_no_seeds_path_error
+      @seeds_path || try_to_guess_seeds_path || raise_no_seeds_path_error
     end
 
     def self.seeds_path=(path)
-      path = path + '/' unless path =~ /\/$/
-      @seeds_path = path
+      @seeds_path = add_trailing_slash_to(path)
     end
 
-
     def initialize(klass, file, args = {})
       @klass = klass
       @file = file
@@ -47,8 +55,8 @@ module Dibber
     end
 
     def build
-      start_log
       check_objects_exist
+      start_log
       objects.each do |name, attributes|
         object = klass.send(retrieval_method, name)
         if overwrite or object.new_record?
@@ -79,5 +87,16 @@ module Dibber
       "find_or_initialize_by_#{name_method}"
     end
 
+    def self.try_to_guess_seeds_path
+      path = File.expand_path('db/seeds', Rails.root) if defined? Rails
+      add_trailing_slash_to(path)
+    end
+
+
+    def self.add_trailing_slash_to(path = nil)
+      path = path + '/' if path and path !~ /\/$/
+      path
+    end
+
   end
 end

data/lib/dibber/version.rb

@@ -1,9 +1,13 @@
 module Dibber
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end
 
 # History
 # =======
+# 0.3.0 Adds seed method
+#       Allows seeding to be carried out via Dibber::Seeder.seed(:thing).
+#       Also tidies up examples
+#
 # 0.2.2 Minor bug fix. There was an error in the example. Also a small bit
 #       of house keeping (adding license to gemspec, and removing Gemfile.lock
 #       from repository.

data/test/dibber/process_log_test.rb

@@ -44,5 +44,11 @@ module Dibber
       expected = ['No finish was 1, now 1.']
       assert_equal(expected, @process_log.report)
     end
+
+    def test_exists_method
+      assert !@process_log.exists?(:one), "There should not be a log for :one yet"
+      test_one
+      assert @process_log.exists?(:one), "There should be log for :one"
+    end
   end
 end

data/test/dibber/seeder_test.rb

@@ -9,7 +9,7 @@ module Dibber
   class SeederTest < Test::Unit::TestCase
     
     def setup
-      Seeder.seeds_path = File.join(File.dirname(__FILE__),'seeds')
+      Seeder.seeds_path = File.join(File.dirname(__FILE__), 'seeds')
     end
     
     def teardown
@@ -121,6 +121,65 @@ module Dibber
       assert_equal([foo, bar], Thing.saved)
       assert_equal({'title' => 'one'}, foo.attributes)
     end
+
+    def test_seed
+      assert_equal(0, Thing.count)
+      Seeder.seed(:things)
+      assert_equal(2, Thing.count)
+      foo = Thing.find_or_initialize_by_name(:foo)
+      bar = Thing.find_or_initialize_by_name(:bar)
+      assert_equal([foo, bar], Thing.saved)
+      assert_equal({'title' => 'one'}, foo.attributes)
+    end
+
+     def test_seed_with_alternative_name_method
+      Seeder.seed(:things, :name_method => 'other_method')
+      assert_equal(2, Thing.count)
+      foo = Thing.find_or_initialize_by_other_method(:foo)
+      bar = Thing.find_or_initialize_by_other_method(:bar)
+      assert_equal([foo, bar], Thing.saved)
+      assert_equal({'title' => 'one'}, foo.attributes)
+    end
+
+    def test_seed_with_non_existent_class
+      assert_raise NameError do
+        Seeder.seed(:non_existent_class)
+      end
+    end
+
+    def test_seed_with_non_existent_seed_file
+      no_file_found_error = Errno::ENOENT
+      assert_raise no_file_found_error do
+        Seeder.seed(:array)
+      end
+    end
+
+    def test_seeds_path_with_none_set
+      Seeder.seeds_path = nil
+      assert_raise RuntimeError do
+        Seeder.seeds_path
+      end
+    end
+
+    def test_process_log_not_reset_by_second_seed_process_on_same_class
+      Seeder.seed(:things)
+      original_start = Seeder.process_log.raw[:things][:start]
+      Seeder.seed(:things)
+      assert_equal original_start, Seeder.process_log.raw[:things][:start]
+    end
+
+    module DummyRails
+      def self.root
+        '/some/path'
+      end
+    end
+
+    def test_seeds_path_if_Rails_exists
+      Dibber.const_set :Rails, DummyRails
+      Seeder.seeds_path = nil
+      assert_equal '/some/path/db/seeds/', Seeder.seeds_path
+      Dibber.send(:remove_const, :Rails)
+    end
     
     
     private

data/test/dibber/thing.rb

@@ -1,55 +1,5 @@
-class Thing
-  attr_reader :name
-  attr_accessor :attributes, :other_method
-  
-  def initialize(name = nil)
-    @name = name.to_s if name
-    self.class.members << self
-  end
-  
-  def save
-    self.class.saved << self if new_record?
-    true
-  end
-  
-  def new_record?
-    !self.class.saved.include? self
-  end
-  
-  def self.find_or_initialize_by_name(name)
-    existing = members.select{|m| m.name == name.to_s}
-    if existing.empty?
-      new(name)
-    else
-      existing.first
-    end
-  end
-  
-  def self.find_or_initialize_by_other_method(data)
-    existing = members.select{|m| m.other_method == data.to_s}
-    if existing.empty?
-      thing = new
-      thing.other_method = data.to_s
-      thing
-    else
-      existing.first
-    end
-  end
-  
-  def self.members
-    @members ||= []
-  end
-  
-  def self.count
-    members.length
-  end
-  
-  def self.saved
-    @saved ||= []
-  end
-  
-  def self.clear_all
-    @members = []
-    @saved = []
-  end
+require_relative '../not_quite_active_record'
+
+class Thing < NotQuiteActiveRecord
+  attr_accessor :other_method
 end

data/test/examples/models/admin_user.rb

@@ -0,0 +1,5 @@
+require_relative '../../not_quite_active_record'
+
+class AdminUser < NotQuiteActiveRecord
+  attr_accessor :title, :header, :footer
+end

data/test/examples/models/borough.rb

@@ -0,0 +1,5 @@
+require_relative '../../not_quite_active_record'
+
+class Borough < NotQuiteActiveRecord
+
+end

data/test/examples/models/category.rb

@@ -0,0 +1,6 @@
+require_relative '../../not_quite_active_record'
+class Category < NotQuiteActiveRecord
+  
+  attr_accessor :description, :title
+
+end

data/test/examples/models/disclaimer.rb

@@ -0,0 +1,6 @@
+require_relative '../../not_quite_active_record'
+module Disclaimer
+  class Document < NotQuiteActiveRecord
+    attr_accessor :title, :header, :footer
+  end
+end

data/test/examples/models/fee.rb

@@ -0,0 +1,5 @@
+require_relative '../../not_quite_active_record'
+
+class Fee < NotQuiteActiveRecord
+  attr_accessor :description, :value, :title
+end

data/{lib → test}/examples/process_logs.rb

@@ -1,4 +1,4 @@
-require_relative '../dibber/process_log'
+require_relative '../../lib/dibber/process_log'
 
 process_log = Dibber::ProcessLog.new
 process_log.start :time_one, 'Time.now'

data/{lib → test}/examples/seeds.rb

@@ -1,7 +1,13 @@
+require_relative '../../lib/dibber'
+
+models = %w{borough admin_user fee disclaimer category}
+models.each {|model| require_relative "models/#{model}"}
+
+
 Seeder = Dibber::Seeder
 
 # Set up the path to seed YAML files
-Seeder.seeds_path = "#{Rails.root}/db/seeds"
+Seeder.seeds_path = File.expand_path('seeds', File.dirname(__FILE__))
 
 # Example 1. Seeder is used to monitor the process 
 # and grab the attributes from the YAML file
@@ -30,22 +36,31 @@ Seeder.new(Fee, 'fees.yml').build
 # Example 4. Seeder using an alternative name field
 Seeder.new(Fee, 'fees.yml', :name_method => :title).build
 
-# Example 5. Seeder working with a name spaced object
+# Example 5. If the seed file's name is the lower case plural of the class name
+# you can use the seed method:
+Seeder.seed(:fee)
+
+# Example 6. Seeder working with a name-spaced object
 Seeder.new(Disclaimer::Document, 'disclaimer/documents.yml').build
 
-# Example 6. Seeder using values in the yaml file to set a single field
-Seeder.new(Category, 'categories.yml', 'description').build
+# Example 7. You can also use the seed method with name-spaced objects.
+# In this case the seed files need to be in a name-spaced path (see previous
+# example)
+Seeder.seed('disclaimer/document')
+
+# Example 8. Seeder using values in the yaml file to set a single field
+Seeder.seed(:category, 'description')
 
-# Example 7. Seeder using alternative name and attributes fields
-Seeder.new(
-  Category, 
-  'categories.yml', 
+# Example 9. Seeder using alternative name and attributes fields
+Seeder.seed(
+  :category,
   :name_method => :title, 
   :attributes_method => :description
-).build
+)
 
-# You can also access Seeders attached process log, and set up a custom log
-Seeder.process_log.start('First questionnaire questions', 'Questionnaire.count > 0 ? Questionnaire.first.questions.length : 0')
+# Example 10. You can also access Seeders attached process log, and set up a
+# custom log
+Seeder.process_log.start('Time to end of report', 'Time.now')
 
 # Output a report showing how the numbers of each type of object
 # have changed through the process. Also has a log of start and end time.

data/test/not_quite_active_record.rb

@@ -0,0 +1,79 @@
+# Mock ActiveRecord::Base
+class NotQuiteActiveRecord
+  attr_reader :name
+  attr_accessor :attributes
+
+  def initialize(name = nil)
+    @name = name.to_s if name
+    self.class.members << self
+  end
+
+  def save
+    self.class.saved << self if new_record?
+    true
+  end
+
+  def new_record?
+    !self.class.saved.include? self
+  end
+
+  def self.find_or_initialize_by_name(name)
+    existing = members.select{|m| m.name == name.to_s}
+    if existing.empty?
+      new(name)
+    else
+      existing.first
+    end
+  end
+
+  def self.find_or_initialize_by_title(title)
+    existing = members.select{|m| m.title == title.to_s}
+    if existing.empty?
+      fee = new
+      fee.title = title
+      fee
+    else
+      existing.first
+    end
+  end
+
+  def self.find_or_create_by_name(name)
+    find_or_initialize_by_name(name).save
+  end
+
+  def self.find_or_initialize_by_other_method(data)
+    existing = members.select{|m| m.other_method == data.to_s}
+    if existing.empty?
+      thing = new
+      thing.other_method = data.to_s
+      thing
+    else
+      existing.first
+    end
+  end
+
+  def self.exists?(hash)
+    !members.select{|m| m.send(hash.first[0]) == hash.first[1].to_s}.empty?
+  end
+
+  def self.create!(hash)
+    new(hash).save
+  end
+
+  def self.members
+    @members ||= []
+  end
+
+  def self.count
+    members.length
+  end
+
+  def self.saved
+    @saved ||= []
+  end
+
+  def self.clear_all
+    @members = []
+    @saved = []
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dibber
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-01 00:00:00.000000000 Z
+date: 2013-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_support
@@ -35,12 +35,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/examples/process_logs.rb
-- lib/examples/seeds/boroughs.yml
-- lib/examples/seeds/disclaimer/documents.yml
-- lib/examples/seeds/fees.yml
-- lib/examples/seeds/categories.yml
-- lib/examples/seeds.rb
 - lib/dibber.rb
 - lib/dibber/version.rb
 - lib/dibber/process_log.rb
@@ -48,6 +42,18 @@ files:
 - MIT-LICENSE
 - Rakefile
 - README.rdoc
+- test/examples/process_logs.rb
+- test/examples/models/admin_user.rb
+- test/examples/models/disclaimer.rb
+- test/examples/models/category.rb
+- test/examples/models/borough.rb
+- test/examples/models/fee.rb
+- test/examples/seeds/boroughs.yml
+- test/examples/seeds/disclaimer/documents.yml
+- test/examples/seeds/fees.yml
+- test/examples/seeds/categories.yml
+- test/examples/seeds.rb
+- test/not_quite_active_record.rb
 - test/dibber/seeder_test.rb
 - test/dibber/thing.rb
 - test/dibber/process_log_test.rb
@@ -80,6 +86,18 @@ signing_key:
 specification_version: 3
 summary: Tool for seeding database from YAML.
 test_files:
+- test/examples/process_logs.rb
+- test/examples/models/admin_user.rb
+- test/examples/models/disclaimer.rb
+- test/examples/models/category.rb
+- test/examples/models/borough.rb
+- test/examples/models/fee.rb
+- test/examples/seeds/boroughs.yml
+- test/examples/seeds/disclaimer/documents.yml
+- test/examples/seeds/fees.yml
+- test/examples/seeds/categories.yml
+- test/examples/seeds.rb
+- test/not_quite_active_record.rb
 - test/dibber/seeder_test.rb
 - test/dibber/thing.rb
 - test/dibber/process_log_test.rb