dibber 0.4.0 → 0.5.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ODFiZTE4ZmRiMjBkNmU1M2NlNDA5NTczMzRmMDZmNWQ3YTljNjZkZQ==
-  data.tar.gz: !binary |-
-    ZmFkYWQ1NzkxM2NjMDVmMGExYTJhMTBkOTJmZTZkNTljODAwYzdjZA==
+SHA1:
+  metadata.gz: df49d47736e3cf6e58a22a2b84d77e76912c8d32
+  data.tar.gz: 03277a6b8d5f532f6ba343bfba8dc71a789785ee
 SHA512:
-  metadata.gz: !binary |-
-    MWI4OGUyZjMxNTU2NTQzZTNhOGU3ZDM5OTY0Yjk0ZjEwOWMzNTYzOTQ5N2U1
-    MjIwNTc3MzUxMmZjZTM2ZTlhOWUxZGJkY2U5MmU4Mjc4OWFkY2MxMTVmNjU4
-    ZGMzNDFkNThjYTgwYzBkZmE0YmNiMjBkNzNjMDJmNjM0ZmQ2N2Y=
-  data.tar.gz: !binary |-
-    NmJmYTM5NjM0ZWYzNmM1MDBmMGFlMmY3ZGUwY2UyYmFhMWM2OTc1ZTFhYzU4
-    OGNlYjJhMDViMDhlNDdjY2RhYzYwODZiODRmYjExYWEyZjBjOGFlOTJlOWMy
-    YWZiYWIyOTZiMmFiMzZhMmE2MWZhNzIyYTJjMjZjOGExN2RhNDI=
+  metadata.gz: 330909b6d4fe39385438b0eda1984c7f1f9571cae69eeba9732bd0927ae9d027ea0f4a6b7fa6324991d446158f89373235bf34c3685f92097cf41e50e0eb4f0f
+  data.tar.gz: 627b1582b890c6721a35f969c15c338372b1f96aa445e48af4ff4f3a12f9d56690a088557a5034c1c2ba44a32c5f0e7da6a59dbb9dbcffe9ce8235f5fcfd7619

data/README.rdoc

@@ -21,9 +21,9 @@ Add this to your Gemfile:
 
 === 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 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:
 
     foo:
       colour: red
@@ -36,42 +36,32 @@ You have a YAML file 'db/seeds/things.yml' that looks like this:
 Add this to your 'db/seeds.rb'
 
     Seeder = Dibber::Seeder
-    Seeder.seed :thing
+    Seeder.seed Thing
     puts Seeder.report
 
-Then run 'rake db:seed'
+Then run `rake db:seed`
 
-Seeder will create two new things. 
+Seeder will create two new things.
 
 You'll then be able to do this:
 
-    thing = Thing.find_by_name(:foo)
+    thing = Thing.find_by(name: 'foo')
     thing.colour    ---> 'red'
 
-=== Outside Rails
+== Report
 
-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  
- 
 Seeder.report outputs a report detailing start and end time, and a log of how
 the number of things has changed
 
 == Overwriting existing entries
 
-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.seed :thing
    thing.reload.colour  ----> 'black'
 
-   Seeder.seed(:thing, :overwrite => true)
+   Seeder.seed(:thing, overwrite: true)
    thing.reload.colour  ----> 'red'
 
 
@@ -83,6 +73,16 @@ the class name:
 
     Seeder.new(Thing, 'other_things.yml').build
 
+== 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 a folder other than 'db/seeds'
+
 == More examples
 
 Take a look at test/examples/seeds.rb for some more usage examples.

data/Rakefile

@@ -14,6 +14,10 @@ Rake::RDocTask.new do |rdoc|
   rdoc.options << '--line-numbers'
 end
 
-Rake::TestTask.new do |t|
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
   t.test_files = FileList['test/**/*_test.rb']
 end
+
+task :default => :test

data/lib/dibber/seeder.rb

@@ -5,44 +5,50 @@ 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
+    class << self
+
+      def seed(klass, args = {})
+        if klass.kind_of?(String) || klass.kind_of?(Symbol)
+          name = klass.to_s
+          class_name = klass.to_s.strip.classify
+          klass = Kernel.const_get(class_name)
+        else
+          name = klass.to_s.underscore
+        end
+        new_file = "#{name.pluralize}.yml"
+        new(klass, new_file, args).build
+      end
 
-    def self.process_log
-      @process_log || start_process_log
-    end
+      def process_log
+        @process_log ||= start_process_log
+      end
 
-    def self.start_process_log
-      @process_log = ProcessLog.new
-      @process_log.start :time, 'Time.now.strftime("%Y-%b-%d %H:%M:%S.%3N %z")'
-      return @process_log
-    end
+      def clear_process_log
+        @process_log = nil
+      end
 
-    def self.report
-      process_log.report + error_report
-    end
+      def report
+        process_log.report + error_report
+      end
 
-    def self.monitor(klass)
-      log_name = klass.to_s.tableize.to_sym
-      unless process_log.exists?(log_name)
-        process_log.start(log_name, "#{klass}.count")
+      def monitor(klass)
+        log_name = klass.to_s.tableize.to_sym
+        unless process_log.exists?(log_name)
+          process_log.start(log_name, "#{klass}.count")
+        end
       end
-    end
 
-    def self.objects_from(file)
-      YAML.load_file("#{seeds_path}#{file}")
-    end
+      def objects_from(file)
+        YAML.load_file("#{seeds_path}#{file}")
+      end
 
-    def self.seeds_path
-      @seeds_path || try_to_guess_seeds_path || raise_no_seeds_path_error
-    end
+      def seeds_path
+        @seeds_path || try_to_guess_seeds_path || raise_no_seeds_path_error
+      end
 
-    def self.seeds_path=(path)
-      @seeds_path = add_trailing_slash_to(path)
+      def seeds_path=(path)
+        @seeds_path = add_trailing_slash_to(path)
+      end
     end
 
     def initialize(klass, file, args = {})
@@ -60,7 +66,7 @@ module Dibber
       objects.each do |name, attributes|
         object = find_or_initialize_by(name)
         if overwrite or object.new_record?
-          object.send("#{attribute_method}=", attributes) 
+          object.send("#{attribute_method}=", attributes)
           unless object.save
             self.class.errors << object.errors
           end
@@ -86,14 +92,20 @@ module Dibber
     end
 
     private
+    def self.start_process_log
+      process_log = ProcessLog.new
+      process_log.start :time, 'Time.now.strftime("%Y-%b-%d %H:%M:%S.%3N %z")'
+      return process_log
+    end
+
     def self.raise_no_seeds_path_error
       raise "You must set the path to your seed files via Seeder.seeds_path = 'path/to/seed/files'"
     end
-    
+
     def check_objects_exist
       raise "No objects returned from file: #{self.class.seeds_path}#{file}" unless objects
     end
-    
+
     def find_or_initialize_by(name)
       if klass.exists?(name_method_sym => name)
         klass.where(name_method_sym => name).first
@@ -101,7 +113,7 @@ module Dibber
         klass.new(name_method_sym => name)
       end
     end
-    
+
     def name_method_sym
       name_method.to_sym
     end

data/lib/dibber/version.rb

@@ -1,12 +1,15 @@
 module Dibber
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end
 
 # History
 # =======
+# 0.5.0 Allow the `Seeder.seed` method to take a Class or the string/symbol
+#       representation of the class name.
+#
 # 0.4.0 Removes dependency on find_or_initialize_by_name type ActiveRecord
 #       dynamic methods that are no longer supported in Rails
-# 
+#
 # 0.3.1 Adds error messages when object save fails
 #
 # 0.3.0 Adds seed method
@@ -19,11 +22,11 @@ end
 #
 # 0.2.1 Fixes bug in overwrite code
 #       System was not correctly identifying when an object was a new record
-# 
+#
 # 0.2.0 Stops overwriting existing entries unless explicitly directed to
 #       Now need to specify :overwrite => true when creating a new Seeder if
 #       existing entries are to be overwritten.
-# 
+#
 # 0.1.1 Working version
 #       No History before this point
 #

data/test/dibber/foo/bar.rb

@@ -0,0 +1,4 @@
+module Foo
+  class Bar < NotQuiteActiveRecord
+  end
+end

data/test/dibber/process_log_test.rb

@@ -1,13 +1,10 @@
-$:.unshift File.join(File.dirname(__FILE__),'../..','lib')
-
-require 'test/unit'
+require 'test_helper'
 require 'dibber'
 
 module Dibber
-  class ProcessLogTest < Test::Unit::TestCase
+  class ProcessLogTest < Minitest::Test
     def setup
       @process_log = ProcessLog.new
-
     end
 
     def test_one

data/test/dibber/seeder_test.rb

@@ -1,12 +1,10 @@
-$:.unshift File.join(File.dirname(__FILE__),'../..','lib')
-
-require 'test/unit'
-require 'dibber'
+require 'test_helper'
 require_relative 'thing'
+require_relative 'foo/bar'
 
 module Dibber
 
-  class SeederTest < Test::Unit::TestCase
+  class SeederTest < Minitest::Test
 
     def setup
       Seeder.seeds_path = File.join(File.dirname(__FILE__), 'seeds')
@@ -14,6 +12,7 @@ module Dibber
 
     def teardown
       Thing.clear_all
+      Foo::Bar.clear_all
     end
 
     def test_process_log
@@ -31,8 +30,15 @@ module Dibber
     end
 
     def test_monitor
+      Seeder.clear_process_log
       Seeder.monitor(Thing)
-      assert_equal({:command => 'Thing.count', :start => Thing.count}, Seeder.process_log.raw[:things])
+      assert_equal({command: 'Thing.count', start: Thing.count}, Seeder.process_log.raw[:things])
+    end
+
+    def test_clear_process_log
+      test_monitor
+      Seeder.clear_process_log
+      assert_equal(nil, Seeder.process_log.raw[:things])
     end
 
     def test_seeds_path
@@ -56,7 +62,7 @@ module Dibber
 
     def test_build_with_no_objects
       thing_seeder = Seeder.new(Thing, 'empty.yml')
-      assert_raise RuntimeError do
+      assert_raises RuntimeError do
         thing_seeder.build
       end
     end
@@ -142,21 +148,71 @@ module Dibber
     end
 
     def test_seed_with_non_existent_class
-      assert_raise NameError do
+      assert_raises 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
+      assert_raises no_file_found_error do
         Seeder.seed(:array)
       end
     end
 
+    def test_seed_with_sub_class_string
+      assert_equal(0, Foo::Bar.count)
+      Seeder.seed('foo/bar')
+      assert_equal(1, Foo::Bar.count)
+      bar = Foo::Bar.find_or_initialize_by(name: :some)
+      assert_equal([bar], Foo::Bar.saved)
+      assert_equal({'title' => 'thing'}, bar.attributes)
+    end
+
+    def test_seed_with_class
+      assert_equal(0, Thing.count)
+      Seeder.seed(Thing)
+      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_class_with_alternative_name_method
+      Seeder.seed(Thing, :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_class_that_does_not_exist
+      assert_raises NameError do
+        Seeder.seed(NonExistentClass)
+      end
+    end
+
+    def test_seed_with_class_with_non_existent_seed_file
+      no_file_found_error = Errno::ENOENT
+      assert_raises no_file_found_error do
+        Seeder.seed(Array)
+      end
+    end
+
+    def test_seed_with_sub_class
+      assert_equal(0, Foo::Bar.count)
+      Seeder.seed(Foo::Bar)
+      assert_equal(1, Foo::Bar.count)
+      bar = Foo::Bar.find_or_initialize_by(name: :some)
+      assert_equal([bar], Foo::Bar.saved)
+      assert_equal({'title' => 'thing'}, bar.attributes)
+    end
+
     def test_seeds_path_with_none_set
       Seeder.seeds_path = nil
-      assert_raise RuntimeError do
+      assert_raises RuntimeError do
         Seeder.seeds_path
       end
     end

data/test/dibber/seeds/foo/bars.yml

@@ -0,0 +1,2 @@
+some:
+  title: thing

data/test/dibber/thing_test.rb

@@ -1,22 +1,20 @@
-$:.unshift File.join(File.dirname(__FILE__),'../..','lib')
-
-require 'test/unit'
+require 'test_helper'
 require_relative 'thing'
 
 module Dibber
 
-  class ThingTest < Test::Unit::TestCase
-    
+  class ThingTest < Minitest::Test
+
     def teardown
       Thing.clear_all
     end
-    
+
     def test_find_or_initialize_by_name
       @name = 'foo'
       @thing = Thing.find_or_initialize_by(name: @name)
       assert_equal(@name, @thing.name)
     end
-    
+
     def test_find_or_initialize_by_name_with_symbol
       test_find_or_initialize_by_name
       assert_equal(1, Thing.count)
@@ -24,33 +22,33 @@ module Dibber
       assert_equal(1, Thing.count)
       assert_equal('foo', thing.name)
     end
-    
+
     def test_find_or_initialize_by_name_when_thing_exists
       test_find_or_initialize_by_name
       test_find_or_initialize_by_name
       assert_equal(1, Thing.count)
     end
-    
+
     def test_count
       assert_equal(0, Thing.count)
       Thing.find_or_initialize_by(name: :thing_for_count_test)
       assert_equal(1, Thing.count)
     end
-    
+
     def test_attributes
       stuff = %w{this that}
       test_find_or_initialize_by_name
       @thing.attributes = stuff
       assert_equal(stuff, @thing.attributes)
     end
-    
+
     def test_other_method
       stuff = %w{come home mother}
       test_find_or_initialize_by_name
       @thing.other_method = stuff
       assert_equal(stuff, @thing.other_method)
     end
-    
+
     def test_save_and_saved
       thing = Thing.find_or_initialize_by(name: :thing_for_save_test)
       assert !Thing.saved.include?(thing), 'saved things should not include thing'
@@ -59,23 +57,23 @@ module Dibber
       thing.save
       assert_equal(1, Thing.saved.select{|t| t == thing}.length)
     end
-    
+
     def test_clear
       test_find_or_initialize_by_name
       @thing.save
-      assert_not_equal(0, Thing.count)
-      assert_not_equal([], Thing.saved)
+      refute_equal(0, Thing.count)
+      refute_equal([], Thing.saved)
       Thing.clear_all
       assert_equal(0, Thing.count)
       assert_equal([], Thing.saved)
     end
-    
+
     def test_find_or_initialize_by_other_method
       thing = Thing.find_or_initialize_by(other_method: :something)
       assert_nil(thing.name)
       assert_equal('something', thing.other_method)
     end
-    
+
   end
 
 end

data/test/examples/seeds.rb

@@ -9,11 +9,11 @@ Seeder = Dibber::Seeder
 # Set up the path to seed YAML files
 Seeder.seeds_path = File.expand_path('seeds', File.dirname(__FILE__))
 
-# Example 1. Seeder is used to monitor the process 
+# Example 1. Seeder is used to monitor the process
 # and grab the attributes from the YAML file
 Seeder.monitor Borough
 Seeder.objects_from("boroughs.yml").each do |holder, borough|
-  Borough.find_or_create_by_name(borough)
+  Borough.find_or_initialize_by(name: borough).save
 end
 
 # Example 2. Seeder is only used to monitor the process
@@ -21,15 +21,15 @@ Seeder.monitor AdminUser
 admin_email = 'admin@undervale.co.uk'
 password = 'change_me'
 AdminUser.create!(
-  :email => admin_email,
-  :password => password,
-  :password_confirmation => password
-) unless AdminUser.exists?(:email => admin_email)
-
-# Example 3. Seeder grabs the attributes from the YAML and builds a 
-# set of Fee objects with those attributes (or updates them if 
-# they already exist). 
-# Note that the build process defaults to using a 'name' field to store 
+  email: admin_email,
+  password: password,
+  password_confirmation: password
+) unless AdminUser.exists?(email: admin_email)
+
+# Example 3. Seeder grabs the attributes from the YAML and builds a
+# set of Fee objects with those attributes (or updates them if
+# they already exist).
+# Note that the build process defaults to using a 'name' field to store
 # the root key.
 Seeder.new(Fee, 'fees.yml').build
 
@@ -38,7 +38,10 @@ Seeder.new(Fee, 'fees.yml', :name_method => :title).build
 
 # 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)
+Seeder.seed :fee
+
+# Alternatively pass in the class:
+Seeder.seed Fee
 
 # Example 6. Seeder working with a name-spaced object
 Seeder.new(Disclaimer::Document, 'disclaimer/documents.yml').build
@@ -46,7 +49,10 @@ Seeder.new(Disclaimer::Document, 'disclaimer/documents.yml').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')
+Seeder.seed 'disclaimer/document'
+
+# or if you prefer to pass in the class:
+Seeder.seed Disclaimer::Document
 
 # Example 8. Seeder using values in the yaml file to set a single field
 Seeder.seed(:category, 'description')
@@ -54,8 +60,8 @@ Seeder.seed(:category, 'description')
 # Example 9. Seeder using alternative name and attributes fields
 Seeder.seed(
   :category,
-  :name_method => :title, 
-  :attributes_method => :description
+  name_method: :title,
+  attributes_method: :description
 )
 
 # Example 10. You can also access Seeders attached process log, and set up a

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.expand_path('../lib', File.dirname(__FILE__))
+require 'dibber'
+
+require 'minitest/autorun'
+
+class Minitest::Test
+#  require 'active_support/testing/assertions'
+#  include ActiveSupport::Testing::Assertions
+
+end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: dibber
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Rob Nichols
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: active_support
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: Packages up code needed to pull data from YAML files when seeding, and
   adds a process log.
 email:
@@ -39,9 +53,11 @@ files:
 - lib/dibber/process_log.rb
 - lib/dibber/seeder.rb
 - lib/dibber/version.rb
+- test/dibber/foo/bar.rb
 - test/dibber/process_log_test.rb
 - test/dibber/seeder_test.rb
 - test/dibber/seeds/empty.yml
+- test/dibber/seeds/foo/bars.yml
 - test/dibber/seeds/things.yml
 - test/dibber/thing.rb
 - test/dibber/thing_test.rb
@@ -57,6 +73,7 @@ files:
 - test/examples/seeds/disclaimer/documents.yml
 - test/examples/seeds/fees.yml
 - test/not_quite_active_record.rb
+- test/test_helper.rb
 homepage: https://github.com/reggieb/Dibber
 licenses:
 - MIT-LICENSE
@@ -67,36 +84,39 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Tool for seeding database from YAML.
 test_files:
-- test/examples/models/admin_user.rb
+- test/dibber/foo/bar.rb
+- test/dibber/seeder_test.rb
+- test/dibber/thing.rb
+- test/dibber/process_log_test.rb
+- test/dibber/seeds/foo/bars.yml
+- test/dibber/seeds/things.yml
+- test/dibber/seeds/empty.yml
+- test/dibber/thing_test.rb
+- test/examples/seeds.rb
+- test/examples/models/borough.rb
 - test/examples/models/disclaimer.rb
-- test/examples/models/fee.rb
 - test/examples/models/category.rb
-- test/examples/models/borough.rb
-- test/examples/seeds/categories.yml
+- test/examples/models/fee.rb
+- test/examples/models/admin_user.rb
 - test/examples/seeds/fees.yml
+- test/examples/seeds/categories.yml
 - test/examples/seeds/disclaimer/documents.yml
 - test/examples/seeds/boroughs.yml
-- test/examples/seeds.rb
 - test/examples/process_logs.rb
 - test/not_quite_active_record.rb
-- test/dibber/seeder_test.rb
-- test/dibber/thing_test.rb
-- test/dibber/seeds/empty.yml
-- test/dibber/seeds/things.yml
-- test/dibber/thing.rb
-- test/dibber/process_log_test.rb
+- test/test_helper.rb