dibber 0.0.3 → 0.1.0

data/README.rdoc

@@ -5,10 +5,53 @@ A set of tools to tidy up rails seeds.rb files.
 Dibber has two compoments:
 
 === Seeder
+
 Seeder is designed to simplify the process of pulling attributes from
 YAML files, and populating ActiveRecord objects with those attributes.
 
 === ProcessLog
+
 ProcessLog provides Seeder with a simple before and after reporting tool.
 
-Have a look at the lib/examples folder, for a guide to how Dibber is used.
+=== Installation
+
+Add this to your Gemfile:
+
+    gem 'dibber'
+
+=== 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:
+
+    foo:
+      colour: red
+      size: large
+
+    bar:
+      colour: blue
+      size: small
+
+Add this to your 'db/seeds.rb'
+
+    Seeder = Dibber::Seeder
+    Seeder.seeds_path = "#{Rails.root}/db/seeds"
+    Seeder.new(Thing, 'things.yml').build
+
+Then run 'rake db:seed'
+
+Seeder will create two new things (unless things with the names 'foo' or
+'bar' already exist, in which case it will update those things with the 
+values in the YAML file). 
+
+You'll then be able to do this:
+
+    thing = Thing.find_by_name(:foo)
+    thing.colour    ---> 'red'
+    
+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.
+
+Have a look at the lib/examples folder, for a more detailed guide to how 
+Dibber is used.

data/lib/dibber/seeder.rb

@@ -1,6 +1,9 @@
+require 'active_support/inflector'
+require 'yaml'
+
 module Dibber
   class Seeder
-    attr_accessor :klass, :file, :method
+    attr_accessor :klass, :file, :attribute_method, :name_method
 
     def self.process_log
       @process_log || start_process_log
@@ -13,7 +16,7 @@ module Dibber
     end
 
     def self.report
-      @process_log.report
+      process_log.report
     end
 
     def self.monitor(klass)
@@ -34,17 +37,20 @@ module Dibber
     end
 
 
-    def initialize(klass, file, method = 'attributes')
+    def initialize(klass, file, args = {})
       @klass = klass
       @file = file
-      @method = method
+      args = {:attributes_method => args} unless args.kind_of?(Hash)
+      @attribute_method = args[:attributes_method] || 'attributes'
+      @name_method = args[:name_method] || 'name'
     end
 
     def build
       start_log
+      check_objects_exist
       objects.each do |name, attributes|
-        object = klass.find_or_initialize_by_name(name)
-        object.send("#{method}=", attributes)
+        object = klass.send(retrieval_method, name)
+        object.send("#{attribute_method}=", attributes)
         object.save
       end
     end
@@ -54,13 +60,21 @@ module Dibber
     end
 
     def objects
-      self.class.objects_from(file)
+      @objects ||= self.class.objects_from(file)
     end
 
     private
     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 retrieval_method
+      "find_or_initialize_by_#{name_method}"
+    end
 
   end
 end

data/lib/dibber/thing.rb

@@ -0,0 +1,51 @@
+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 unless self.class.saved.include? self
+    true
+  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
+end

data/lib/dibber/version.rb

@@ -1,3 +1,3 @@
 module Dibber
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/examples/seeds.rb

@@ -23,18 +23,30 @@ AdminUser.create!(
 # 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 requires the model to have a name field.
+# Note that the build process defaults to using a 'name' field to store 
+# the root key.
 Seeder.new(Fee, 'fees.yml').build
 
-# Example 4. Seeder working with a name spaced object
+# Example 4. Seeder using an alternative name field
+Seeder.new(Fee, 'fees.yml', :name_field => :title).build
+
+# Example 5. Seeder working with a name spaced object
 Seeder.new(Disclaimer::Document, 'disclaimer/documents.yml').build
 
-# Example 5. Seeder using values in the yaml file to set a single field
+# Example 6. Seeder using values in the yaml file to set a single field
 Seeder.new(Category, 'categories.yml', 'description').build
 
+# Example 7. Seeder using alternative name and attributes fields
+Seeder.new(
+  Category, 
+  'categories.yml', 
+  :name_field => :title, 
+  :attributes_field => :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')
+
 # 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.
 puts Seeder.report
-
-# 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')

data/test/dibber/seeder_test.rb

@@ -0,0 +1,112 @@
+$:.unshift File.join(File.dirname(__FILE__),'../..','lib')
+
+require 'test/unit'
+require 'dibber'
+require 'dibber/thing'
+
+module Dibber
+
+  class SeederTest < Test::Unit::TestCase
+    
+    def setup
+      Seeder.seeds_path = File.join(File.dirname(__FILE__),'seeds')
+    end
+    
+    def teardown
+      Thing.clear_all
+    end
+    
+    def test_process_log
+      assert_kind_of(ProcessLog, Seeder.process_log)
+    end
+    
+    def test_process_log_start
+      @log = Seeder.process_log
+      assert(@log.raw.keys.include?(:time), 'time should be logged')
+    end
+    
+    def test_report
+      test_process_log_start
+      assert_equal(@log.report, Seeder.report)
+    end
+    
+    def test_monitor
+      Seeder.monitor(Thing)
+      assert_equal({:command => 'Thing.count', :start => Thing.count}, Seeder.process_log.raw[:things])
+    end
+    
+    def test_seeds_path
+      assert_match(/test\/dibber\/seeds\/$/, Seeder.seeds_path)
+    end
+    
+    def test_objects_from
+      content = YAML.load_file(thing_file_path)
+      assert_equal(content, Seeder.objects_from('things.yml'))
+    end
+    
+    def test_start_log
+      thing_seeder.start_log
+      assert(Seeder.process_log.raw.keys.include?(:things), 'Things should be logged')
+    end
+    
+    def test_objects
+      content = YAML.load_file(thing_file_path)
+      assert_equal(content, thing_seeder.objects)
+    end
+    
+    def test_build_with_no_objects
+      thing_seeder = Seeder.new(Thing, 'empty.yml')
+      assert_raise RuntimeError do
+        thing_seeder.build
+      end
+    end
+    
+    def test_build
+      assert_equal(0, Thing.count)
+      thing_seeder.build
+      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_other_method_replacing_attributes
+      thing_seeder('other_method').build
+      foo = Thing.find_or_initialize_by_name(:foo)
+      bar = Thing.find_or_initialize_by_name(:bar)
+      assert_equal([foo, bar], Thing.saved)
+      assert_nil(foo.attributes)
+      assert_equal({'title' => 'one'}, foo.other_method)
+    end
+    
+    def test_other_method_replacing_attributes_via_args
+      thing_seeder(:attributes_method => 'other_method').build
+      foo = Thing.find_or_initialize_by_name(:foo)
+      bar = Thing.find_or_initialize_by_name(:bar)
+      assert_equal([foo, bar], Thing.saved)
+      assert_nil(foo.attributes)
+      assert_equal({'title' => 'one'}, foo.other_method)
+    end
+    
+    def test_alternative_name_method
+      thing_seeder(:name_method => 'other_method').build
+      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
+    
+    
+    private
+    def thing_seeder(method = 'attributes')
+      @thing_seeder = Seeder.new(Thing, 'things.yml', method)
+    end
+    
+    def thing_file_path
+      File.join(File.dirname(__FILE__),'seeds', 'things.yml')
+    end
+  end
+  
+end

data/test/dibber/seeds/empty.yml

@@ -0,0 +1,2 @@
+## YAML Template.
+---

data/test/dibber/seeds/things.yml

@@ -0,0 +1,5 @@
+foo:
+  title: one
+  
+bar:
+  title: two

data/test/dibber/thing_test.rb

@@ -0,0 +1,81 @@
+$:.unshift File.join(File.dirname(__FILE__),'../..','lib')
+
+require 'test/unit'
+require 'dibber/thing'
+
+module Dibber
+
+  class ThingTest < Test::Unit::TestCase
+    
+    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)
+      thing = Thing.find_or_initialize_by_name(:foo)
+      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'
+      assert thing.save, 'should return true on save'
+      assert Thing.saved.include?(thing), 'saved things should include thing'
+      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)
+      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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dibber
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-19 00:00:00.000000000 Z
-dependencies: []
+date: 2013-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Packages up code needed to pull data from YAML files when seeding, and
   adds a process log.
 email:
@@ -27,12 +43,17 @@ files:
 - lib/examples/seeds.rb
 - lib/dibber.rb
 - lib/dibber/version.rb
+- lib/dibber/thing.rb
 - lib/dibber/process_log.rb
 - lib/dibber/seeder.rb
 - MIT-LICENSE
 - Rakefile
 - README.rdoc
+- test/dibber/seeder_test.rb
 - test/dibber/process_log_test.rb
+- test/dibber/seeds/empty.yml
+- test/dibber/seeds/things.yml
+- test/dibber/thing_test.rb
 homepage: https://github.com/reggieb/Dibber
 licenses: []
 post_install_message: 
@@ -58,4 +79,8 @@ signing_key:
 specification_version: 3
 summary: Tool for seeding database from YAML.
 test_files:
+- test/dibber/seeder_test.rb
 - test/dibber/process_log_test.rb
+- test/dibber/seeds/empty.yml
+- test/dibber/seeds/things.yml
+- test/dibber/thing_test.rb