dibber 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Rob Nichols
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,14 @@
+== Dibber
+
+A set of tool to tidy up rails seeds.rb files.
+
+Dibber has two compoments:
+
+=== Seeder
+is designed to simplify the process of pulling attributes from
+YAML files, and populating ActiveRecord objects with those attributes.
+
+=== ProcessLog
+provides Seeder with a simple before and after reporting tool.
+
+Have a look at the examples folder, for a guide to how Dibber is used.

data/Rakefile

@@ -0,0 +1,19 @@
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rdoc/task'
+require 'rake/testtask'
+
+Rake::RDocTask.new do |rdoc|
+  files =['README.rdoc', 'MIT-LICENSE', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.rdoc" # page to start on
+  rdoc.title = "Dibber Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end

data/lib/dibber.rb

@@ -0,0 +1,7 @@
+require_relative 'dibber/process_log'
+require_relative 'dibber/seeder'
+require_relative 'dibber/version'
+
+module Dibber
+    
+end

data/lib/dibber/process_log.rb

@@ -0,0 +1,33 @@
+module Dibber
+  class ProcessLog
+
+    def initialize
+      @log = {}
+    end
+
+    def start(name, command)
+      @log[name] = {
+        :start => eval(command),
+        :command => command
+      }
+    end
+
+    def finish(name)
+      @log[name][:finish] = eval(@log[name][:command])
+    end
+
+    def raw
+      @log
+    end
+
+    def report
+      @report = []
+      @log.each do |name, log|
+        finish(name) unless @log[name][:finish]
+        @report << "#{name.to_s.capitalize.gsub(/_/, ' ')} was #{log[:start]}, now #{log[:finish]}."
+      end
+      return @report
+    end
+
+  end
+end

data/lib/dibber/seeder.rb

@@ -0,0 +1,66 @@
+module Dibber
+  class Seeder
+    attr_accessor :klass, :file, :method
+
+    def self.process_log
+      @process_log || start_process_log
+    end
+
+    def self.start_process_log
+      @process_log = ProcessLog.new
+      @process_log.start :time, 'Time.now.to_s(:long_time)'
+      return @process_log
+    end
+
+    def self.report
+      @process_log.report
+    end
+
+    def self.monitor(klass)
+      process_log.start(klass.to_s.tableize.to_sym, "#{klass}.count")
+    end
+
+    def self.objects_from(file)
+      YAML.load_file("#{seeds_path}#{file}")
+    end
+
+    def self.seeds_path
+      @seeds_path || raise_no_seeds_path_error
+    end
+
+    def self.seeds_path=(path)
+      path = path + '/' unless path =~ /\/$/
+      @seeds_path = path
+    end
+
+
+    def initialize(klass, file, method = 'attributes')
+      @klass = klass
+      @file = file
+      @method = method
+    end
+
+    def build
+      start_log
+      objects.each do |name, attributes|
+        object = klass.find_or_initialize_by_name(name)
+        object.send("#{method}=", attributes)
+        object.save
+      end
+    end
+
+    def start_log
+      self.class.monitor(klass)
+    end
+
+    def 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
+
+  end
+end

data/lib/dibber/version.rb

@@ -0,0 +1,3 @@
+module Dibber
+  VERSION = "0.0.2"
+end

data/lib/examples/process_logs.rb

@@ -0,0 +1,15 @@
+require_relative 'process_log'
+
+process_log = ProcessLog.new
+process_log.start :time_one, 'Time.now'
+sleep(2)
+process_log.finish :time_one
+
+process_log.start :time_two, 'Time.now'
+sleep(4)
+
+puts "\nReport:"
+puts process_log.report
+puts "\nRaw:"
+p process_log.raw
+puts "\n"

data/lib/examples/seeds.rb

@@ -0,0 +1,37 @@
+Seeder = Dibble::Seeder
+
+# Set up the path to seed YAML files
+Seeder.seeds_path = "#{Rails.root}/db/seeds"
+
+# 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)
+end
+
+# Example 2. Seeder is only used to monitor the process
+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 build 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.
+Seeder.new(Fee, 'fees.yml').build
+
+# Example 4. 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
+Seeder.new(Category, 'categories.yml', 'description').build
+
+# Output a report showing how the numbers of each type of object
+# have changed through the process.
+puts Seeder.report

data/lib/examples/seeds/boroughs.yml

@@ -0,0 +1,6 @@
+stratford:     Stratford on Avon
+rugby:         Rugby
+north_warwick: North Warwickshire
+nuneaton:      Nuneaton and Bedworth
+warwick:       Warwick
+

data/lib/examples/seeds/categories.yml

@@ -0,0 +1,3 @@
+one: First
+two: Second
+three: Third

data/lib/examples/seeds/disclaimer/documents.yml

@@ -0,0 +1,4 @@
+main:
+  title: Disclaimer
+  header: Don't do it.
+  footer: Click to accept.

data/lib/examples/seeds/fees.yml

@@ -0,0 +1,7 @@
+annual:
+  description: One hundred
+  value: 100
+
+deposit:
+  description: Seventy five
+  value: 75

data/test/dibber/process_log_test.rb

@@ -0,0 +1,48 @@
+$:.unshift File.join(File.dirname(__FILE__),'../..','lib')
+
+require 'test/unit'
+require 'dibber'
+
+module Dibber
+  class ProcessLogTest < Test::Unit::TestCase
+    def setup
+      @process_log = ProcessLog.new
+
+    end
+
+    def test_one
+      @process_log.start(:one, '1')
+      @process_log.finish(:one)
+
+      expected = {:one => {:start => 1, :finish => 1, :command => '1'}}
+      assert_equal(expected, @process_log.raw)
+    end
+
+    def test_two
+      test_one
+      @process_log.start(:two, '2')
+      @process_log.finish(:two)
+
+      expected = {
+        :one => {:start => 1, :finish => 1, :command => '1'},
+        :two => {:start => 2, :finish => 2, :command => '2'}
+      }
+      assert_equal(expected, @process_log.raw)
+    end
+
+    def test_report
+      test_two
+      expected = [
+        'One was 1, now 1.',
+        'Two was 2, now 2.'
+      ]
+      assert_equal(expected, @process_log.report)
+    end
+
+    def test_report_with_no_finish
+      @process_log.start(:no_finish, '1')
+      expected = ['No finish was 1, now 1.']
+      assert_equal(expected, @process_log.report)
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: dibber
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Rob Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-07 00:00:00.000000000 Z
+dependencies: []
+description: Packages up code needed to pull data from YAML files when seeding, and
+  adds a process log.
+email:
+- rob@undervale.co.uk
+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
+- lib/dibber/seeder.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/dibber/process_log_test.rb
+homepage: https://github.com/reggieb/Dibber
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Tool for seeding database from YAML.
+test_files:
+- test/dibber/process_log_test.rb