dibber 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: df49d47736e3cf6e58a22a2b84d77e76912c8d32
-  data.tar.gz: 03277a6b8d5f532f6ba343bfba8dc71a789785ee
+SHA256:
+  metadata.gz: 7ac217e07668aaa17e034576c170a3e7736ea6bdedc5776bc05c197ad0604f1a
+  data.tar.gz: 6b07f8f169bd0e2e9f3cfd0aa9a9c86d4f4a10dba5f75ebeda44ef4c8b507fd0
 SHA512:
-  metadata.gz: 330909b6d4fe39385438b0eda1984c7f1f9571cae69eeba9732bd0927ae9d027ea0f4a6b7fa6324991d446158f89373235bf34c3685f92097cf41e50e0eb4f0f
-  data.tar.gz: 627b1582b890c6721a35f969c15c338372b1f96aa445e48af4ff4f3a12f9d56690a088557a5034c1c2ba44a32c5f0e7da6a59dbb9dbcffe9ce8235f5fcfd7619
+  metadata.gz: 25af64ca3571627ccead7c5c873dd72548d6b58997311b22ad3cd459bbd28e78d4238cb17e8dbaf77e2b144dea0b9ecd5a0fae6b4c31519535a794277fc0616a
+  data.tar.gz: abaedc7100af6b56597d4faedced8e17704cddc5212c0e2842ffd293642b357f1653e03d89605636b0917788893cf77d55e40aec677d7c6ae899a3fa86c53bc9

data/README.rdoc

@@ -48,6 +48,39 @@ You'll then be able to do this:
     thing = Thing.find_by(name: 'foo')
     thing.colour    ---> 'red'
 
+=== Pass the name of the class to seed
+
+All of these are equivalent commands
+
+    Dibber::Seeder.seed Thing
+    Dibber::Seeder.seed :thing
+    Dibber::Seeder.seed 'Thing'
+
+=== Dynamic content
+
+Seed content can also have dynamic content added via ERB. For example, if
+you want the colour of the `foo` thing to be either 'red' or 'yellow', change
+`db/seeds/things.yml` to
+
+    foo:
+      colour: <%= ['red', 'yellow'].sample %>
+      size: large
+
+Then when we run `Dibber::Seeder.seed :thing` a new `Thing` will be created
+with the colour set to either 'red' or 'yellow'.
+
+=== Using blocks with Seeder
+
+If you pass a block to `.seed` the block will be called on each object being
+built as it is created or updated.
+
+So for example, if Thing has attributes `size` and `big` the following is
+possible:
+
+    Dibber::Seeder.seed(:thing) do |thing|
+      thing.big = thing.attributes['size'] > 10
+    end
+
 == Report
 
 Seeder.report outputs a report detailing start and end time, and a log of how
@@ -94,9 +127,3 @@ If you clone this app, you can run this example at the project root:
 There is also an example of process log usage:
 
     ruby test/examples/process_logs.rb
-
-
-
-
-
-

data/lib/dibber/seeder.rb

@@ -1,5 +1,6 @@
 require 'active_support/inflector'
 require 'yaml'
+require 'erb'
 
 module Dibber
   class Seeder
@@ -7,16 +8,16 @@ module Dibber
 
     class << self
 
-      def seed(klass, args = {})
+      def seed(klass, args = {}, &block)
         if klass.kind_of?(String) || klass.kind_of?(Symbol)
-          name = klass.to_s
+          name = klass.to_s.underscore
           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
+        new(klass, new_file, args).build(&block)
       end
 
       def process_log
@@ -39,7 +40,15 @@ module Dibber
       end
 
       def objects_from(file)
-        YAML.load_file("#{seeds_path}#{file}")
+        YAML.load erb_processed(file_content(file))
+      end
+
+      def erb_processed(content)
+        ERB.new(content).result
+      end
+
+      def file_content(file)
+        File.read File.join(seeds_path, file)
       end
 
       def seeds_path
@@ -63,14 +72,16 @@ module Dibber
     def build
       check_objects_exist
       start_log
-      objects.each do |name, attributes|
+      objects.map do |name, attributes|
         object = find_or_initialize_by(name)
         if overwrite or object.new_record?
           object.send("#{attribute_method}=", attributes)
+          yield(object) if block_given?
           unless object.save
             self.class.errors << object.errors
           end
         end
+        object
       end
     end
 
@@ -130,4 +141,4 @@ module Dibber
     end
 
   end
-end
+end

data/lib/dibber/version.rb

@@ -1,9 +1,14 @@
 module Dibber
-  VERSION = "0.5.0"
+  VERSION = "0.7.0"
 end
 
 # History
 # =======
+# 0.7.0 Adds ability to pass blocks into Seeder.seed and Seed#build
+#
+# 0.6.0 ERB parse the source files before passing it to YAML. Allows dynamic
+#       content to be used.
+#
 # 0.5.0 Allow the `Seeder.seed` method to take a Class or the string/symbol
 #       representation of the class name.
 #

data/test/dibber/dynamic_thing_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+require_relative 'thing'
+
+module Dibber
+  class DynamicThingTest < Minitest::Test
+
+    def setup
+      Seeder.seeds_path = File.join(File.dirname(__FILE__), 'seeds')
+    end
+
+
+    def test_objects_from
+      hash = Seeder.objects_from('dynamic_things.yml')
+      assert_equal 'something', hash['one']['title']
+    end
+
+  end
+end

data/test/dibber/seeder_test.rb

@@ -38,7 +38,7 @@ module Dibber
     def test_clear_process_log
       test_monitor
       Seeder.clear_process_log
-      assert_equal(nil, Seeder.process_log.raw[:things])
+      assert_nil Seeder.process_log.raw[:things], "Log should be empty"
     end
 
     def test_seeds_path
@@ -71,12 +71,20 @@ module Dibber
       assert_equal(0, Thing.count)
       thing_seeder.build
       assert_equal(2, Thing.count)
-      foo = Thing.find_or_initialize_by(name:  :foo)
+      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_build_with_block
+      other = 'other'
+      thing_seeder.build { |t| t.other_method = other }
+      foo = Thing.find_or_initialize_by(name: :foo)
+      bar = Thing.find_or_initialize_by(name: :bar)
+      assert_equal([foo, bar], Thing.where(other_method: other))
+    end
+
     def test_rebuilding_does_not_overwrite
       test_build
       attributes = {'title' => 'something else'}
@@ -138,7 +146,22 @@ module Dibber
       assert_equal({'title' => 'one'}, foo.attributes)
     end
 
-     def test_seed_with_alternative_name_method
+    def test_seed_with_block
+      other = 'other'
+      Seeder.seed(:things) { |thing| thing.other_method = other }
+      foo = Thing.find_or_initialize_by(name: :foo)
+      bar = Thing.find_or_initialize_by(name: :bar)
+      assert_equal([foo, bar], Thing.where(other_method: other))
+    end
+
+    def test_seed_with_block_using_attributes
+      other = 'other'
+      Seeder.seed(:things) { |thing| thing.other_method = thing.attributes['title'] }
+      foo = Thing.find_or_initialize_by(name: :foo)
+      assert_equal('one', foo.other_method)
+    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)
@@ -179,7 +202,17 @@ module Dibber
       assert_equal({'title' => 'one'}, foo.attributes)
     end
 
-     def test_seed_with_class_with_alternative_name_method
+    def test_seed_with_class_name
+      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)
@@ -244,7 +277,7 @@ module Dibber
     end
 
     def thing_file_path
-      File.join(File.dirname(__FILE__),'seeds', 'things.yml')
+      File.join(File.dirname(__FILE__), 'seeds', 'things.yml')
     end
   end
 

data/test/dibber/seeds/dynamic_things.yml

@@ -0,0 +1,2 @@
+one:
+  title: <%= 'something' %>

data/test/not_quite_active_record.rb

@@ -7,7 +7,7 @@ class NotQuiteActiveRecord
     extract_attributes
     self.class.members << self
   end
-  
+
   def extract_attributes
     attributes.each do |name, value|
       self.send("#{name}=", value.to_s) if self.respond_to?(name.to_sym)
@@ -22,11 +22,11 @@ class NotQuiteActiveRecord
   def new_record?
     !self.class.saved.include? self
   end
-  
+
   def self.where(hash)
     members.select{|m| hash.collect{|k, v| m.send(k) == v.to_s}.uniq == [true]}
   end
-  
+
   def self.find_or_initialize_by(hash)
     if exists?(hash)
       where(hash).first

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dibber
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Rob Nichols
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 2022-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,16 +28,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 description: Packages up code needed to pull data from YAML files when seeding, and
   adds a process log.
 email:
@@ -53,9 +53,11 @@ files:
 - lib/dibber/process_log.rb
 - lib/dibber/seeder.rb
 - lib/dibber/version.rb
+- test/dibber/dynamic_thing_test.rb
 - test/dibber/foo/bar.rb
 - test/dibber/process_log_test.rb
 - test/dibber/seeder_test.rb
+- test/dibber/seeds/dynamic_things.yml
 - test/dibber/seeds/empty.yml
 - test/dibber/seeds/foo/bars.yml
 - test/dibber/seeds/things.yml
@@ -76,7 +78,7 @@ files:
 - test/test_helper.rb
 homepage: https://github.com/reggieb/Dibber
 licenses:
-- MIT-LICENSE
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -93,30 +95,31 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.3.22
 signing_key: 
 specification_version: 4
 summary: Tool for seeding database from YAML.
 test_files:
+- test/dibber/dynamic_thing_test.rb
 - test/dibber/foo/bar.rb
-- test/dibber/seeder_test.rb
-- test/dibber/thing.rb
 - test/dibber/process_log_test.rb
+- test/dibber/seeder_test.rb
+- test/dibber/seeds/dynamic_things.yml
+- test/dibber/seeds/empty.yml
 - test/dibber/seeds/foo/bars.yml
 - test/dibber/seeds/things.yml
-- test/dibber/seeds/empty.yml
+- test/dibber/thing.rb
 - test/dibber/thing_test.rb
-- test/examples/seeds.rb
+- test/examples/models/admin_user.rb
 - test/examples/models/borough.rb
-- test/examples/models/disclaimer.rb
 - test/examples/models/category.rb
+- test/examples/models/disclaimer.rb
 - test/examples/models/fee.rb
-- test/examples/models/admin_user.rb
-- test/examples/seeds/fees.yml
+- test/examples/process_logs.rb
+- test/examples/seeds/boroughs.yml
 - test/examples/seeds/categories.yml
 - test/examples/seeds/disclaimer/documents.yml
-- test/examples/seeds/boroughs.yml
-- test/examples/process_logs.rb
+- test/examples/seeds/fees.yml
+- test/examples/seeds.rb
 - test/not_quite_active_record.rb
 - test/test_helper.rb