model-builder 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: badad59df7fa705f88cd6c2a46528b6e2c7ba99a
-  data.tar.gz: 3854a69631e6c472fbe0785ab8e7b42eacff7d5d
+  metadata.gz: 755f69f2759cbef81f648647073101f1e832d18e
+  data.tar.gz: 918e0c1720b2a2349e1430d39bb1be546cbde95d
 SHA512:
-  metadata.gz: 075df025384ee090201b909a2c36104df271279362df11ab132ab65215acf2063a65759ebe6c30a2320a30b1b7eb6a80d502532b4341b5e8be5ab6e4ca3b4599
-  data.tar.gz: f07b7c319e6b5af8e52519f6f247779266b113f06ecdafc2900a40cd273b1841c362b0c5ab47c6d1644c970f805b785315f32d8cdbd03bc418de7d0abd9eb17b
+  metadata.gz: c55813b933ad427308bc20e31b61b0ce6a9146795df9ec7908c89e8cc5bed85de58759828d22e22dca5fd1cf57bd8549a3808ce4dc3b5d8b115bed75ad2f9a31
+  data.tar.gz: 47c71a7ef9a882b0cee79ce1d7ba4484c0d486cc08c37f8d7da8de0b2c84dac8972c9f09ebf32a55651f44aef9e34f96d674547d4b779e301701ba1ae7e9f218

data/README.rdoc

@@ -1,51 +1,60 @@
 = Model Builder
 
 Build active record models on the fly.
-Handy during tests creation, when the development is not related to business intelligence (and should not reference it).
 
-Something like this:
+Handy when using TDD to develop a reusable component, that is not strictly related to the business intelligence of a project (and should not reference it).
 
-    # migration
+== Scenario
 
-    class CreatePlayers < ActiveRecord::Migration
-      def change
-        create_table :players do |t|
-          t.string :name
-          t.integer :age, default: 18
-        end
+Consider this case of code duplication:
+
+    class User < ActiveRecord::Base
+      def map_all_names
+        to_a.map &:name
       end
     end
 
-    # model
+    class Topic < ActiveRecord::Base
+      def map_all_names
+        to_a.map &:name
+      end
+    end
 
-    class Player < ActiveRecord::Base
-      validates :name, :age, presence: true
-      validates :age, numericality: true
+We can easily improve this through an abstraction:
+
+    class User < ActiveRecord::Base
+      include NameUtils
     end
 
-Can be done at runtime:
-
-    options = {
-      attributes: {
-        name: :string,
-        age: { type: :integer, default: 18 }
-      },
-      validates: [
-        [:name, :age, presence: true],
-        [:age, numericality: true]
-      ]
-    }
+    class Topic < ActiveRecord::Base
+      include NameUtils
+    end
 
-    ModelBuilder.build 'Player', options
+    module NameUtils extend ActiveSupport::Concern
+      included do
+        define_singleton_method :map_all_names do
+          all.map &:name
+        end
+      end
+    end
 
-After all, you can drop tables with:
+Nice. Now we have a reusable abstraction, that could even fit in a gem to be applied at another projects.
 
-    ModelBuilder.clean
+But thinking about the gem context, we will not be able to use user or topic models at our tests.
+They belong to our business intelligence. So, how to test it?
 
-Simple classes are welcome too:
+Here comes the necessity of don't rely on our business intelligence at abstractions tests.
+
+== Solution
+
+    ModelBuilder.build 'MappableName', {
+      includes: NameUtils,
+      attributes: { name: :string },
+      validates: [:name, presence: true]
+    }
 
-    ModelBuilder::ClassBuilder.build 'Duck', superclass: 'Animal', accessors: %w(age size)
+Now your 'MappableName' model is able to receive NameUtils tests:
 
-If you want your object to quack like active record, see this:
+    MappableName.map_all_names
 
-* https://github.com/makandra/active_type
+See the full test example here[https://github.com/r4z3c/model-builder/blob/master/spec/examples/name_utils_spec.rb].

data/lib/model_builder/class_builder.rb

@@ -4,12 +4,13 @@ module ModelBuilder
     @@dynamic_classes ||= []
 
     def self.build(name, opts={})
-      return name.constantize if Object.const_defined? name
+      return Object.const_get name if Object.const_defined? name
 
       klass = get_class_from_options opts
       Object.const_set name, klass
 
       add_class klass
+      include_modules klass, opts[:includes]
       create_accessors klass, opts[:accessors]
 
       klass
@@ -25,14 +26,19 @@ module ModelBuilder
       superclass.is_a?(String) ? superclass.constantize : superclass
     end
 
-    def self.list
-      @@dynamic_classes
-    end
-
     def self.add_class(klass)
       @@dynamic_classes << klass
     end
 
+    def self.include_modules(klass, modules)
+      return if modules.nil?
+      modules = [modules] unless modules.is_a? Array
+      modules.each do |m|
+        m_const = m.kind_of?(String) ? Object.const_get(m) : m
+        klass.send :include, m_const
+      end
+    end
+
     def self.create_accessors(klass, accessors=[])
       return if accessors.nil?
       accessors = [accessors] unless accessors.is_a? Array
@@ -43,5 +49,14 @@ module ModelBuilder
       klass.send 'attr_accessor', accessor unless accessor.nil?
     end
 
+    def self.clean
+      list.map {|c| Object.send :remove_const, c.to_s }
+      @@dynamic_classes = []
+    end
+
+    def self.list
+      @@dynamic_classes
+    end
+
   end
 end

data/lib/model_builder/version.rb

@@ -1,3 +1,3 @@
 module ModelBuilder
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

data/lib/model_builder.rb

@@ -62,6 +62,8 @@ module ModelBuilder
 
   def self.clean
     list.map {|c| drop_table c }
+    @@dynamic_models = []
+    ClassBuilder.clean
   end
 
   def self.list

data/spec/examples/name_utils_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'support/database_connection'
+
+Spec::Support::DatabaseConnection.establish_sqlite_connection
+
+module NameUtils extend ActiveSupport::Concern
+  included do
+    define_singleton_method :map_all_names do
+      all.map &:name
+    end
+  end
+end
+
+describe NameUtils do
+
+  before do
+    create_mappable_names_model
+    populate_mappable_names_table
+  end
+
+  after { ModelBuilder.clean }
+
+  subject { MappableName.map_all_names }
+
+  it { is_expected.to match %w(Name0 Name1 Name2) }
+
+  def create_mappable_names_model
+    ModelBuilder.build 'MappableName', {
+      includes: NameUtils,
+      attributes: { name: :string },
+      validates: [:name, presence: true]
+    }
+  end
+
+  def populate_mappable_names_table
+    3.times {|i| MappableName.create! name: "Name#{i}" }
+  end
+
+end

data/spec/lib/model_builder/class_builder_spec.rb

@@ -1,28 +1,60 @@
 require 'spec_helper'
+require 'support/dummy_module'
 
 describe ModelBuilder::ClassBuilder do
 
   let(:builder) { ModelBuilder::ClassBuilder }
   let(:name) { 'ClassBuilderTest' }
-  let(:options) { { superclass: Array, accessors: %w(a1 a2) } }
-  let(:constant) { name.constantize }
+  let(:options) { { superclass: Array, includes: [Spec::Support::DummyModule], accessors: %w(a1 a2) } }
+  let(:constant) { Object.const_get name }
 
-  subject { builder.build name, options }
+  before { @build_result = builder.build name, options }
 
-  it { is_expected.to eq constant }
-  it { expect(builder.list).to include constant }
+  after { ModelBuilder::ClassBuilder.clean }
 
-  context 'accessors validations' do
+  describe '.build' do
 
-    before { subject }
+    subject { @build_result }
 
-    it { expect(constant.new).to respond_to :a1 }
-    it { expect(constant.new).to respond_to :a2 }
-    it { expect(constant.new).to_not respond_to :a3 }
+    it { is_expected.to eq constant }
+    it { expect(builder.list).to include constant }
 
-    it { expect(constant.new).to respond_to :a1= }
-    it { expect(constant.new).to respond_to :a2= }
-    it { expect(constant.new).to_not respond_to :a3= }
+    context 'includes validations' do
+
+      before { subject }
+
+      it { expect(constant.new).to respond_to :dummy_method }
+
+    end
+
+    context 'accessors validations' do
+
+      before { subject }
+
+      it { expect(constant.new).to respond_to :a1 }
+      it { expect(constant.new).to respond_to :a2 }
+      it { expect(constant.new).to_not respond_to :a3 }
+
+      it { expect(constant.new).to respond_to :a1= }
+      it { expect(constant.new).to respond_to :a2= }
+      it { expect(constant.new).to_not respond_to :a3= }
+
+    end
+
+  end
+
+  describe '.clean' do
+
+    it { expect{constant}.to_not raise_error }
+
+    context 'after build' do
+
+      before { builder.clean }
+
+      it { expect{constant}.to raise_error(NameError, "uninitialized constant #{name}") }
+      it { expect(builder.list.empty?).to be true }
+
+    end
 
   end
 

data/spec/lib/model_builder_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'support/database_connection'
+require 'support/dummy_module'
 
 Spec::Support::DatabaseConnection.establish_sqlite_connection
 
@@ -11,6 +12,7 @@ describe ModelBuilder do
   let(:default_age) { 17 }
   let(:options) do
     {
+      includes: [Spec::Support::DummyModule],
       attributes: {
         name: :string,
         age: {
@@ -25,44 +27,70 @@ describe ModelBuilder do
     }
   end
 
-  subject { builder.build name, options }
+  before { @build_result = builder.build name, options }
 
-  it { is_expected.to eq constant }
-  it { expect(builder.list).to include constant }
+  after { ModelBuilder.clean }
 
-  context 'options validations' do
+  describe '.build' do
 
-    before { subject }
+    subject { @build_result }
 
-    subject(:instance) { constant.new }
+    it { is_expected.to eq constant }
+    it { expect(builder.list).to include constant }
 
-    context 'attributes validations' do
+    context 'options validations' do
 
-      it { is_expected.to respond_to :name }
-      it { is_expected.to respond_to :age }
+      before { subject }
 
-      it { is_expected.to respond_to :name= }
-      it { is_expected.to respond_to :age= }
+      subject(:instance) { constant.new }
 
-      it { expect(instance.age).to eq default_age }
+      context 'includes validations' do
 
-    end
+        it { expect(instance).to respond_to :dummy_method }
+
+      end
+
+      context 'attributes validations' do
+
+        it { is_expected.to respond_to :name }
+        it { is_expected.to respond_to :age }
 
-    context 'validations validations' do
+        it { is_expected.to respond_to :name= }
+        it { is_expected.to respond_to :age= }
+
+        it { expect(instance.age).to eq default_age }
 
-      before do
-        instance.age = 'noop'
-        instance.valid?
       end
 
-      it { expect(instance.valid?).to be false }
-      it { expect(instance.errors.messages.keys).to include :name }
-      it { expect(instance.errors.messages.keys).to include :age }
+      context 'validations validations' do
+
+        before do
+          instance.age = 'noop'
+          instance.valid?
+        end
+
+        it { expect(instance.valid?).to be false }
+        it { expect(instance.errors.messages.keys).to include :name }
+        it { expect(instance.errors.messages.keys).to include :age }
+
+      end
 
     end
 
   end
 
-  after(:all) { ModelBuilder.clean }
+  describe '.clean' do
+
+    it { expect(constant.all.count).to eq 0 }
+
+    context 'after build' do
+
+      before { builder.clean }
+      it { expect{constant}.to raise_error(NameError, "uninitialized constant #{name}") }
+      it { expect(builder.list.empty?).to be true }
+
+    end
+
+  end
 
 end

data/spec/support/dummy_module.rb

@@ -0,0 +1,11 @@
+require 'model_builder'
+
+module Spec
+  module Support
+    module DummyModule
+
+      def dummy_method; :dummy_return; end
+
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model-builder
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - r4z3c
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-26 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,10 +97,12 @@ files:
 - lib/model_builder/class_builder.rb
 - lib/model_builder/version.rb
 - model_builder.gemspec
+- spec/examples/name_utils_spec.rb
 - spec/lib/model_builder/class_builder_spec.rb
 - spec/lib/model_builder_spec.rb
 - spec/spec_helper.rb
 - spec/support/database_connection.rb
+- spec/support/dummy_module.rb
 homepage: https://github.com/r4z3c/model-builder.git
 licenses:
 - MIT
@@ -126,7 +128,9 @@ signing_key:
 specification_version: 4
 summary: Active record runtime model builder
 test_files:
+- spec/examples/name_utils_spec.rb
 - spec/lib/model_builder/class_builder_spec.rb
 - spec/lib/model_builder_spec.rb
 - spec/spec_helper.rb
 - spec/support/database_connection.rb
+- spec/support/dummy_module.rb