active_container 0.0.1

data/license/lgplv3.md

@@ -0,0 +1,171 @@
+This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+
+0. Additional Definitions.
+--------------------------
+
+As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+"The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+
+1. Exception to Section 3 of the GNU GPL.
+--------------------------------------------------------------------------------
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+
+2. Conveying Modified Versions.
+--------------------------------------------------------------------------------
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+* a) under this License, provided that you make a good faith effort to
+     ensure that, in the event an Application does not supply the
+     function or data, the facility still operates, and performs
+     whatever part of its purpose remains meaningful, or
+
+* b) under the GNU GPL, with none of the additional permissions of
+     this License applicable to that copy.
+
+
+3. Object Code Incorporating Material from Library Header Files.
+--------------------------------------------------------------------------------
+
+The object code form of an Application may incorporate material from
+a header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+* a) Give prominent notice with each copy of the object code that the
+     Library is used in it and that the Library and its use are
+     covered by this License.
+
+* b) Accompany the object code with a copy of the GNU GPL and this license
+     document.
+
+
+4. Combined Works.
+--------------------------------------------------------------------------------
+
+You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+* a) Give prominent notice with each copy of the Combined Work that
+     the Library is used in it and that the Library and its use are
+     covered by this License.
+
+* b) Accompany the Combined Work with a copy of the GNU GPL and this license
+     document.
+
+* c) For a Combined Work that displays copyright notices during
+     execution, include the copyright notice for the Library among
+     these notices, as well as a reference directing the user to the
+     copies of the GNU GPL and this license document.
+
+* d) Do one of the following:
+
+  * 0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+  * 1) Use a suitable shared library mechanism for linking with the
+       Library. A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+* e) Provide Installation Information, but only if you would otherwise
+     be required to provide such information under section 6 of the
+     GNU GPL, and only to the extent that such information is
+     necessary to install and execute a modified version of the
+     Combined Work produced by recombining or relinking the
+     Application with a modified version of the Linked Version. (If
+     you use option 4d0, the Installation Information must accompany
+     the Minimal Corresponding Source and Corresponding Application
+     Code. If you use option 4d1, you must provide the Installation
+     Information in the manner specified by section 6 of the GNU GPL
+     for conveying Corresponding Source.)
+
+
+5. Combined Libraries.
+--------------------------------------------------------------------------------
+
+You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+* a) Accompany the combined library with a copy of the same work based
+     on the Library, uncombined with any other library facilities,
+     conveyed under the terms of this License.
+
+* b) Give prominent notice with the combined library that part of it
+     is a work based on the Library, and explaining where to find the
+     accompanying uncombined form of the same work.
+
+
+6. Revised Versions of the GNU Lesser General Public License.
+--------------------------------------------------------------------------------
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/readme.md

@@ -0,0 +1,298 @@
+[![Build Status](https://travis-ci.org/ToadJamb/active_container.svg?branch=chore%2Ftravis-ci)](https://travis-ci.org/ToadJamb/active_container)
+
+ActiveContainer
+===============
+
+Trim the fatty models. Use ActiveContainer.
+
+ActiveContainer doesn't just keep your models thin,
+it keeps your tests away from the database.
+Completely.
+FactoryGirl's `build` and `build_stubbed` require db access.
+And even RSpec ActiveModel Mocks can't avoid attempting to open a connection
+when you call ANY function on the model.
+
+You can get away from this easily and safely with ActiveContainer.
+
+More to come...
+
+
+Installation
+------------
+
+    $ gem install active_container
+
+
+Gemfile
+-------
+
+    $ gem 'active_container'
+
+
+Require
+-------
+
+    $ require 'active_container'
+
+
+Usage
+-----
+
+Please note that this example is not necessarily for a Rails project.
+In particular, namespacing may not need to be explicit.
+
+Naming is important! Wrappers for `MyModel` *MUST* be named `MyModelWrapper`.
+
+
+### Example
+
+Let's wear out the blog post example:
+
+```
+# models/person.rb
+class Person < ActiveRecord::Base
+  has_many :posts
+
+  validates :first_name, :presence => true
+  validates :last_name, :presence => true
+  validates :full_name, :presence => true
+
+  validate :custom_validation
+
+  def custom_validation
+    # do custom validation
+  end
+end
+
+# models/post.rb
+class Post < ActiveRecord::Base
+  has_one :author, :through => :person
+
+  validates :title, :presence => true
+  validates :body, :presence => true
+end
+
+# models/wrappers/post_wrapper.rb
+class PostWrapper < ActiveContainer::Wrapper
+end
+
+# models/wrappers/person_wrapper.rb
+class PersonWrapper < ActiveContainer::Wrapper
+  include Wrappers::Person::FullName
+  include Wrappers::Person::PostCount
+
+  delegate :first_name, :last_name
+
+  wrap_delegate :posts
+end
+
+# models/wrappers/person/full_name.rb
+module Wrappers
+  module Person
+    module FullName
+      def full_name
+        "#{first_name} #{last_name}"
+      end
+
+      # This logic is overly simplified for example purposes only.
+      def full_name=(value)
+        names = value.split(' ')
+
+        @record.full_name = value     # Must use `@record` here
+        self.first_name = names.first # We can use either `@record` or `self`.
+        self.last_name  = names.last  # We can use either `@record` or `self`.
+      end
+    end
+  end
+end
+
+# models/wrappers/person/post_count.rb
+module Wrappers
+  module Person
+    module PostCount
+      def post_count
+        post.count
+      end
+    end
+  end
+end
+
+```
+
+It is important that the helpers are included prior to calling
+`delegate` as there are checks to ensure that assignment
+methods do not already exist.
+
+`ActiveContainer::Wrapper` automatically passes `id` to the underlying model,
+so it does not need to be included in the list sent to `delegate`.
+
+
+### Commentary
+
+#### Goals
+
+##### Reduce code in models (including `include` statements)
+
+The only code that is left in the model is limited to ActiveRecord/ActiveModel
+relationships, validations, etc.
+
+These can get out of hand on their own in large projects.
+This way, nothing but the essentials are in your models.
+
+
+##### Increase test speed
+
+One of the primary goals was to get completely away from the database
+during testing.
+
+This means not even so much as opening a connection
+and this may not even be possible if you work with anything that has
+knowledge of the ActiveRecord object you're working with.
+
+This includes FactoryGirl's `build` and `build_stubbed`.
+Even `mock_model` will attempt to open a database connection
+if you call a method you haven't mocked out
+(it wasn't mocked because we wanted to run the code!).
+
+
+##### More explicit model interfaces
+
+ActiveRecord models tell you little about what attributes you actually have.
+You specify the methods that pass through to the underlying models,
+so that interface is clearly seen when examining a Wrapper.
+
+Along with this, it is recommended that functionality is grouped in *VERY SMALL*
+chunks via mixins for the wrappers.
+
+This allows easier testing of the mixins and tells you more about the interface
+for the wrapper.
+
+
+##### Encapsulation of model lifecycle events.
+
+ActiveRecord callbacks are the devil's work.
+ActiveContainer lets you take control again.
+
+It can be used only for that, if you like:
+
+    $ Person.new(:first_name => 'John').wrap.save # where save has custom logic
+
+A simple example:
+
+```
+# models/wrappers/person_wrapper.rb
+class PersonWrapper < ActiveContainer::Wrapper
+  def save
+    if !@record.save
+      # do something
+    end
+  end
+end
+```
+
+
+If you want to apply logic to all models, simply create your own BaseWrapper:
+
+```
+# models/wrappers/base_wrapper.rb
+class BaseWrapper < ActiveContainer::Wrapper
+  def save
+    if !@record.save
+      # do something
+    end
+  end
+end
+
+# models/wrappers/person_wrapper.rb
+class PersonWrapper < BaseWrapper
+  def save
+    if !@record.save
+      # do something
+    end
+  end
+end
+```
+
+
+Testing
+-------
+
+Like Drake, let's start at the bottom.
+
+```
+#spec/models/wrappers/person/full_name_spec.rb
+# It is expected that `spec_helper` will load you files
+# without even THINKING about a database connection.
+require 'spec_helper'
+
+RSpec.describe Wrappers::Person::FullName do
+  subject { PersonWrapper.new person }
+
+  let(:person) do
+    OpenStruct.new \
+      :first_name => first_name,
+      :last_name  => last_name,
+  end
+
+  describe '#full_name' do
+    shared_examples_for 'a full name' do |first, last, expected|
+      context "given a first name of #{first.inspect}" do
+        let(:first_name) { first_name }
+
+        context "given a last name of #{last.inspect}" do
+          let(:last_name) { last_name }
+
+          it "returns #{expected.inspect}" do
+            expect(subject.full_name).to eq expected
+          end
+        end
+      end
+    end
+
+    it_behaves_like 'a full name', 'Tom', 'Jones', 'Tom Jones'
+    it_behaves_like 'a full name', 'Tiny ', ' Tim ', 'Tiny  Tim '
+  end
+end
+
+#spec/models/wrappers/person_wrapper_spec.rb
+require 'spec/app_helper' # or rails_helper or whatever includes the full app.
+RSpec.describe PersonWrapper do
+  subject { PersonWrapper.new person }
+
+  let(:person) do
+    # this or FactoryGirl.build_stubbed
+    Person.new \
+      :first_name => first_name,
+      :last_name  => last_name,
+  end
+
+  describe '#full_name' do
+    context 'given first and last name of Dizzy and Gillespie' do
+      let(:first_name) { 'Dizzy' }
+      let(:last_name)  { 'Gillespie' }
+
+      it 'returns Dizzy Gillespie' do
+        expect(subject.full_name).to eq 'Dizzy Gillespie'
+      end
+    end
+  end
+end
+```
+
+
+### Notes
+
+The `PersonWrapper` is a fairly poor example.
+The important thing here is that `#full_name`
+gets called *at some point* in this group of tests.
+
+It is not important that it be tested explicitly.
+By reducing the number of tests at this level to be just enough
+to ensure integration with the individual components (including the model),
+we can speed up our test suite dramatically.
+
+The biggest concern at this level is not whether the logic is correct,
+but whether we have changed attribute names without updating
+the mocked objects we use at the lower level.
+
+This is the tradeoff.