blueprints 0.6.2 → 0.6.3

data/Rakefile

@@ -19,3 +19,53 @@ Rake::RDocTask.new do |rd|
   rd.main = "README.rdoc"
   rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
 end
+
+namespace :db do
+  desc "Create database structure"
+  task :prepare do
+    require 'rubygems'
+    require 'active_record'
+
+    Dir.chdir File.dirname(__FILE__)
+
+    ActiveRecord::Base.logger = Logger.new("debug.log")
+
+    databases = YAML::load(IO.read("spec/active_record/fixtures/database.yml"))
+    db_info = databases[ENV["DB"] || "test"]
+    ActiveRecord::Base.establish_connection(db_info)
+
+    load("spec/active_record/fixtures/schema.rb")
+  end
+end
+
+desc "Convert rspec specs to test/unit tests"
+task :rspec_to_test do
+  Dir.chdir File.dirname(__FILE__)
+  data = IO.read('spec/active_record/blueprints_spec.rb')
+
+  data.gsub!("require File.dirname(__FILE__) + '/spec_helper'", "require File.dirname(__FILE__) + '/test_helper'")
+  data.gsub!("describe Blueprints do", 'class BlueprintsTest < ActiveSupport::TestCase')
+
+  # lambda {
+  #   hornsby_clear :undo => :just_orange
+  # }.should raise_error(ArgumentError)
+  data.gsub!(/(\s+)lambda \{\n(.*)\n(\s+)\}.should raise_error\((.*)\)/, "\\1assert_raise(\\4) do\n\\2\n\\3end")
+  # should =~ => assert_similar
+  data.gsub!(/^(\s+)(.*)\.should\s*=~\s*(.*)/, '\1assert_similar(\2, \3)')
+
+  # .should_not => assert(!())
+  data.gsub!(/^(\s+)(.*)\.should_not(.*)/, '\1assert(!(\2\3))')
+  # .should => assert()
+  data.gsub!(/^(\s+)(.*)\.should(.*)/, '\1assert(\2\3)')
+  # be_nil => .nil?
+  data.gsub!(/ be_([^\(\)]*)/, '.\1?')
+  # have(2).items => .size == 2
+  data.gsub!(/ have\((\d+)\)\.items/, '.size == \1')
+
+  data.gsub!(/^(\s+)describe/, '\1context')
+  data.gsub!(/^(\s+)it (["'])(should )?/, '\1should \2')
+  data.gsub!(/^(\s+)before.*do/, '\1setup do')
+  data.gsub!(/^(\s+)after.*do/, '\1teardown do')
+
+  File.open('test/blueprints_test.rb', 'w') {|f| f.write(data)}
+end

data/VERSION

@@ -1 +1 @@
-0.6.2
+0.6.3

data/blueprints.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{blueprints}
-  s.version = "0.6.2"
+  s.version = "0.6.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrius Chamentauskas"]
@@ -39,8 +39,6 @@ Gem::Specification.new do |s|
      "lib/blueprints/namespace.rb",
      "lib/blueprints/plan.rb",
      "lib/blueprints/root_namespace.rb",
-     "script/load_schema",
-     "script/rspec_to_test",
      "spec/active_record/blueprint.rb",
      "spec/active_record/blueprints_spec.rb",
      "spec/active_record/fixtures/database.yml.example",

data/lib/blueprints.rb

@@ -1,4 +1,7 @@
 require 'active_support'
+require 'active_support/core_ext'
+require 'set'
+
 files = %w{
 context buildable namespace root_namespace plan file_context helper errors
 database_backends/abstract database_backends/active_record database_backends/none

data/lib/blueprints/buildable.rb

@@ -1,6 +1,6 @@
 module Blueprints
   class Buildable
-    class Dependency < Struct.new(:name)
+    class Dependency < Struct.new(:name) # :nodoc:
       alias :to_sym :name
 
       def iv_name
@@ -11,6 +11,10 @@ module Blueprints
     attr_reader :name
     attr_accessor :namespace
 
+    # Initializes new Buildable object by name.
+    # Name can be Symbol, String or Hash. If Hash is passed, then first key is assumed name, and value(s) of that key
+    # are assumed as dependencies. Raises error class of name parameter is not what is expected.
+    # Warns if name has already been taken.
     def initialize(name)
       @name, parents = parse_name(name)
       depends_on(*parents)
@@ -26,6 +30,10 @@ module Blueprints
     end
 
     # Builds dependencies of blueprint and then blueprint itself.
+    #
+    # +build_once+ - pass false if you want to build despite the fact that it was already built.
+    #
+    # +options+ - list of options to be accessible in the body of a blueprint. Defaults to empty Hash.
     def build(build_once = true, options = {})
       each_namespace {|namespace| namespace.build_parents }
       build_parents
@@ -39,6 +47,8 @@ module Blueprints
       end
     end
 
+    # If value is passed then it sets attributes for this buildable object.
+    # Otherwise returns attributes (defaulting to empty Hash)
     def attributes(value = nil)
       if value
         raise value.inspect + @name if @name == ''

data/lib/blueprints/context.rb

@@ -3,6 +3,7 @@ module Blueprints
   class Context
     attr_accessor :options, :attributes
 
+    # Method that allows building one blueprint inside of another. Simply delegates to root namespace.
     def build(*names)
       Namespace.root.build(*names)
     end

data/lib/blueprints/extensions/rspec.rb

@@ -1,6 +1,5 @@
-extend_class = defined?(RSpec) ? RSpec::Core::Configuration : Spec::Runner::Configuration
-
-extend_class.class_eval do
+# Module that gets included into RSpec Configuration class to provide enable_blueprints method.
+module Blueprints::RspecMixin
   # Enables blueprints in rspec. Is automatically added if <tt>Spec</tt> is defined at loading time or <tt>script/spec</tt>
   # is used. You might need to require it manually in certain case (eg. running specs from metrics).
   # Accepts options hash. For supported options please check Blueprints.load.
@@ -16,3 +15,21 @@ extend_class.class_eval do
     end
   end
 end
+
+if defined?(RSpec)
+  module RSpec #:nodoc:
+    module Core #:nodoc:
+      class Configuration
+        include  Blueprints::RspecMixin
+      end
+    end
+  end
+else
+  module Spec #:nodoc:
+    module Runner #:nodoc:
+      class Configuration
+        include Blueprints::RspecMixin
+      end
+    end
+  end
+end

data/lib/blueprints/helper.rb

@@ -20,6 +20,11 @@ module Blueprints
       Namespace.root.build(names, self, false)
     end
 
+    # Returns attributes that are used to build blueprint. To set what attributes are used you need to call attributes
+    # method when defining blueprint like this:
+    #   blueprint :apple do
+    #     Fruit.build attributes
+    #   end.attributes(:name => 'apple')
     def build_attributes(name)
       Namespace.root[name].attributes
     end

data/lib/blueprints/namespace.rb

@@ -6,16 +6,19 @@ module Blueprints
     attr_reader :children
     delegate :empty?, :size, :to => :@children
 
+    # Creates namespace by name. See Buildable#new.
     def initialize(name)
       super(name)
       @children = {}
     end
 
+    # Adds child to namespaces children. Child should be instance of Buildable.
     def add_child(child)
       @children[child.name] = child
       child.namespace = self
     end
 
+    # Finds child by relative name. Raises PlanNotFoundError if child can't be found.
     def [](path)
       child_name, path = path.to_s.split('.', 2)
       child = @children[child_name.to_sym] or raise PlanNotFoundError, child_name
@@ -26,6 +29,7 @@ module Blueprints
       end
     end
 
+    # Builds all children and sets instance variable named by name of namespace with the results.
     def build_self(build_once = true)
       Namespace.root.add_variable(path, @children.collect {|p| p.last.build }.uniq)
     end

data/spec/active_record/blueprints_spec.rb

@@ -394,14 +394,14 @@ describe Blueprints do
 
   it "should warn when blueprint with same name exists" do
     STDERR.expects(:puts).with("**WARNING** Overwriting existing blueprint: 'overwritten'")
-    STDERR.expects(:puts).with(regexp_matches(/^blueprints_spec\.rb:\d+:in `new'$/))
+    STDERR.expects(:puts).with(regexp_matches(/blueprints_(spec|test)\.rb:\d+:in `new'/))
     Blueprints::Plan.new(:overwritten)
     Blueprints::Plan.new(:overwritten)
   end
 
   it "should warn when building with options and blueprint is already built" do
     STDERR.expects(:puts).with("**WARNING** Building with options, but blueprint was already built: 'big_cherry'")
-    STDERR.expects(:puts).with(regexp_matches(/^blueprints_spec\.rb:\d+$/))
+    STDERR.expects(:puts).with(regexp_matches(/blueprints_(spec|test)\.rb:\d+/))
     build :big_cherry => {:species => 'some species'}
   end
 

data/test/blueprints_test.rb

@@ -264,6 +264,11 @@ class BlueprintsTest < ActiveSupport::TestCase
       fruits = Fruit.blueprint([{:species => 'fruit1'}, {:species => 'fruit2'}])
       assert(fruits.collect(&:species) == %w{fruit1 fruit2})
     end
+
+    should "allow to build oak without attributes" do
+      build :oak_without_attributes
+      assert(@oak_without_attributes.instance_of?(Tree))
+    end
   end
 
   context "with pitted namespace" do
@@ -360,6 +365,11 @@ class BlueprintsTest < ActiveSupport::TestCase
       assert(@small_acorn == @acorn)
     end
 
+    should "not reset options after call to build" do
+      build :small_acorn => {:option => 'value'}
+      assert(@small_acorn_options == {:option => 'value'})
+    end
+
     should "allow to use shortcut to extend blueprint" do
       build :huge_acorn
       assert(@huge_acorn.average_diameter == 100)
@@ -369,6 +379,11 @@ class BlueprintsTest < ActiveSupport::TestCase
       build :huge_acorn
       assert(@huge_acorn.tree.size == 'huge')
     end
+
+    should "allow to pass options when building extended blueprint" do
+      build :huge_acorn => {:average_diameter => 200}
+      assert(@huge_acorn.average_diameter == 200)
+    end
   end
 
   should "allow to build! without checking if it was already built" do
@@ -378,13 +393,15 @@ class BlueprintsTest < ActiveSupport::TestCase
   end
 
   should "warn when blueprint with same name exists" do
-    $stderr.expects(:puts).with("**WARNING** Overwriting existing blueprint: 'overwritten'")
+    STDERR.expects(:puts).with("**WARNING** Overwriting existing blueprint: 'overwritten'")
+    STDERR.expects(:puts).with(regexp_matches(/blueprints_(spec|test)\.rb:\d+:in `new'/))
     Blueprints::Plan.new(:overwritten)
     Blueprints::Plan.new(:overwritten)
   end
 
   should "warn when building with options and blueprint is already built" do
     STDERR.expects(:puts).with("**WARNING** Building with options, but blueprint was already built: 'big_cherry'")
+    STDERR.expects(:puts).with(regexp_matches(/blueprints_(spec|test)\.rb:\d+/))
     build :big_cherry => {:species => 'some species'}
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: blueprints
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 6
-  - 2
-  version: 0.6.2
+  - 3
+  version: 0.6.3
 platform: ruby
 authors: 
 - Andrius Chamentauskas
@@ -51,8 +51,6 @@ files:
 - lib/blueprints/namespace.rb
 - lib/blueprints/plan.rb
 - lib/blueprints/root_namespace.rb
-- script/load_schema
-- script/rspec_to_test
 - spec/active_record/blueprint.rb
 - spec/active_record/blueprints_spec.rb
 - spec/active_record/fixtures/database.yml.example

data/script/load_schema

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems'
-require 'active_record'
-
-Dir.chdir File.join(File.dirname(__FILE__), '..')
-
-ActiveRecord::Base.logger = Logger.new("debug.log")
-
-databases = YAML::load(IO.read("spec/active_record/fixtures/database.yml"))
-db_info = databases[ENV["DB"] || "test"]
-ActiveRecord::Base.establish_connection(db_info)
-
-load("spec/active_record/fixtures/schema.rb")

data/script/rspec_to_test

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-Dir.chdir File.join(File.dirname(__FILE__), '..')
-data = IO.read('spec/active_record/blueprints_spec.rb')
-
-data.gsub!("require File.dirname(__FILE__) + '/spec_helper'", "require File.dirname(__FILE__) + '/test_helper'")
-data.gsub!("describe Blueprints do", 'class BlueprintsTest < ActiveSupport::TestCase')
-
-# lambda {
-#   hornsby_clear :undo => :just_orange
-# }.should raise_error(ArgumentError)
-data.gsub!(/(\s+)lambda \{\n(.*)\n(\s+)\}.should raise_error\((.*)\)/, "\\1assert_raise(\\4) do\n\\2\n\\3end")
-# should =~ => assert_similar
-data.gsub!(/^(\s+)(.*)\.should\s*=~\s*(.*)/, '\1assert_similar(\2, \3)')
-
-# .should_not => assert(!())
-data.gsub!(/^(\s+)(.*)\.should_not(.*)/, '\1assert(!(\2\3))')
-# .should => assert()
-data.gsub!(/^(\s+)(.*)\.should(.*)/, '\1assert(\2\3)')
-# be_nil => .nil?
-data.gsub!(/ be_([^\(\)]*)/, '.\1?')
-# have(2).items => .size == 2
-data.gsub!(/ have\((\d+)\)\.items/, '.size == \1')
-
-data.gsub!(/^(\s+)describe/, '\1context')
-data.gsub!(/^(\s+)it (["'])(should )?/, '\1should \2')
-data.gsub!(/^(\s+)before.*do/, '\1setup do')
-data.gsub!(/^(\s+)after.*do/, '\1teardown do')
-
-File.open('test/blueprints_test.rb', 'w') {|f| f.write(data)}