levee 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcd858e4786b09e8a9ba17285b17b0f0b8f1c824
-  data.tar.gz: b3c1da36324aa5c7a2198f7de69a2e8ae9d38e63
+  metadata.gz: 4c7914e86b72b6401588783ca7bae634b4999da7
+  data.tar.gz: d9716f4148d31fb9a37fb5d9a3891a5aad3809e5
 SHA512:
-  metadata.gz: 4db403789b42ba351f7a66f0bfa57b9e5e094dea2c520e8e254e44a510ccd3c87a45dc9005cefaa0145aab4270d293a4f6368862f7bfa74154d874c60f39e9ad
-  data.tar.gz: 3136ad1286c7ecc2b8d12546ffd76203407b15ce384927944d16215bd0e1b49a3c2c3922f96b7fec395f75f56ee2ecf73dcb25f0232fafd9335a520758d3042b
+  metadata.gz: 69a2eb7d1d755284a542f40410eb49b76a4528423c653648210a89ee90a56e5f163a7c301d66c78cd1e014ee18c2b0759b1d22458b6f7b9762da863304678d88
+  data.tar.gz: 08ea0de0d98c6f98645cbe5cf67ef6112a6b3afaa7561745c36741adca7ed4456255871004722c938e692ce826b9f8e30978a2febd573111515d219511dfe7e1

data/README.md

@@ -23,9 +23,10 @@ Or install it yourself as:
 Overview
 ------------------------
 
-The abstract builder and validator classes are abstract classes for concrete builder classes to inherit from. They will be extracted to a gem once they are imporved and generalized through this project.
+The abstract builder and validator classes are abstract classes for concrete builder classes to inherit from.
+The purpose of the builder object is to create a layer of abstraction between the controller and models in a Rails application. 
 
-The purpose of the builder object is to create a layer of abstraction between the controller and models in a Rails application. The builder is particularly useful for receiving complex post and put requests with multiple parameters, but is lightweight enough to use for simple writes when some filtering or parameter combination validation might be useful before writing to the database. Since it wraps the entire write action to mulitple models in a single transaction, any failure in the builder will result in the entire request being rolled back. 
+The builder is particularly useful for receiving complex post and put requests with multiple parameters, but is lightweight enough to use for simple writes when some filtering or parameter combination validation might be useful before writing to the database. Since it wraps the entire write action to mulitple models in a single transaction, any failure in the builder will result in the entire request being rolled back. 
 
 
 Features
@@ -50,7 +51,7 @@ The TL;DR copy & paste version:
 Save this somewhere in your app directory. Maybe in a builders folder?
 
 
-      class PostBuilder < BaseBuilder
+      class PostBuilder < Levee::Builder
         #matches the class name
 
         #make sure you list all params that are passed in (you can skip id if you want)
@@ -63,7 +64,7 @@ Save this somewhere in your app directory. Maybe in a builders folder?
         #list as many before_save and after_save callbacks as you want
         after_save :tweet_post
 
-        #choose a validator class to run automatically (must be a legit base validator)
+        #choose a validator class to run automatically (must be a legit levee validator class)
         validator PostParamsValidator
 
         #access the model using #object
@@ -142,7 +143,7 @@ Let me say that again. The return value of custom methods does not automatically
 The id key is the only key in the params hash that does not need to be whitelisted and will not be mapped by default. It can still be overridden if you want to catch the id and do someting with it, or if you want to cue some other action just before the attribute mapping executes.
 
 
-###The object Object
+###The object object
 
 
 As in ActiveModel::Serializers, the builder makes use of the object object within the class. This allows for code that easily reusable between create and update requests. Behind the scenes the base builder uses the id the the params hash to look up the existing object form the inferred model and represents it as object. If no :id parameter exists a new empty object of that class is instantiated and assigned to object. Buidler methods then don't need to know or care about whether object is new or existing and can treat it the same. In the cases where this might be important, you are of course free to dig into object and ask it all sorts of ActiveRecord questions about its state inside your overwriter methods. 
@@ -183,7 +184,7 @@ Moar Features
 
 You can list macro-style callbacks inside the class just like in your ActiveRecord models. 
 
-      class PostBuilder
+      class PostBuilder < Levee::Builder
 
         attributes :title,
                    :content,
@@ -214,7 +215,7 @@ Just be sure you define the methods you list somewhere within the class, otherwi
 The builder implements #delayed_saved(object) to be used inside a builder class. This is a shortcut for calling save! on any object as part of the after save callbacks. It is useful for when you are creating nested objects inside a builder and you want to be sure that the parent object is saved first, as is the case with associations where you need to be sure the parent has all attributes in place to pass validattion before the child forces a save. Note that delayed_save callbacks fire before the rest of the after_save callbacks.
 
 
-      class PostBuilder
+      class PostBuilder < Levee::Builder
 
         attributes :title,
                    :content,
@@ -264,7 +265,7 @@ You can make a validator class to be used with your builder. It's a good place t
 Make the class like this. You can put it anywhere in the app directory, but it feels very at home in a folder called validations. It doesn't use class inference so you can call it whatever
 
 
-      class UltraSweetValidator < BaseValidator
+      class UltraSweetValidator < Levee::Validator
     
         validations :first_method,
                     :other_method
@@ -296,7 +297,7 @@ When you find something you don't like, you can either use the super userful #ad
 Call the validator inside the builder by listing the class name 
 
 
-      class PostBuilder < BaseBuilder
+      class PostBuilder < Levee::Builder
 
         attributes :title,
                    :content,
@@ -315,10 +316,6 @@ Don't bother validating simple params in your validator that map straight onto t
 
 
 
-
-
-TODO: Write usage instructions here
-
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/levee/fork )

data/lib/levee/version.rb

@@ -1,7 +1,7 @@
 module Levee
   extend self
 
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 
   def gem_description
     %Q(The purpose of the builder object is to create a layer of abstraction between the controller and models in a Rails application. The builder is particularly useful for receiving complex post and put requests with multiple parameters, but is lightweight enough to use for simple writes when some filtering or parameter combination validation might be useful before writing to the database. Since it wraps the entire write action to mulitple models in a single transaction, any failure in the builder will result in the entire request being rolled back.)

data/lib/levee.rb

@@ -1,3 +1,4 @@
 require "levee/version"
 require "levee/builder"
+require "levee/validator"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: levee
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Mike Martinson
@@ -70,9 +70,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- builder/base_builder_spec.rb
-- builder/builder_helper.rb
-- levee-0.0.1.gem
+- levee-0.0.2.gem
 - levee.gemspec
 - lib/levee.rb
 - lib/levee/builder.rb

data/builder/base_builder_spec.rb

@@ -1,311 +0,0 @@
-require 'rails_helper'
-require_relative './builder_helper.rb'
-
-#Base builder is an abstract class. A test class is made in /spec/support/test_builder.rb that defines 
-#a concrete child class.
-
-describe 'BaseBuidler' do
-  let(:demo_class) { DemoTest }
-  let(:params) { {name: 'test params',
-                  content: 'none'} }
-  subject { DemoTestBuilder.new(params) }
-
-  describe 'initialization' do
-    it 'sets requires_save to true' do
-      expect(subject.requires_save).to be 
-    end
-  end
-
-  describe '#build' do
-    let(:object_class) { double(find_by: nil) }
-    before do 
-      allow(object_class).to receive(:new) { demo_class.new }
-      allow(subject).to receive(:object_class) { object_class  }
-      allow(subject).to receive(:assign_parameters_in_transaction)
-    end
-
-    context 'when the parameters are a top level array' do
-      it 'calls #assign_parameters_in_transaction' do
-        subject.params = []
-        expect(subject).to receive(:assign_parameters_in_transaction)
-        subject.build
-      end
-    end
-
-    context 'when the parameters are an object that contains an id' do
-      before { subject.params[:id] = 4 }
-
-      it 'class #find_by on #object class with params[:id]' do
-        expect(object_class).to receive(:find_by).with({id: subject.params[:id]})
-        subject.build
-      end
-    end
-
-    context 'when the parameters are an object that does not contain an id' do
-
-      it 'calls #object_class' do
-        expect(subject).to receive(:object_class)
-        subject.build
-      end
-
-      it 'assigns a newly instantiated object of object_class to builder#object' do
-        allow(subject).to receive(:assign_parameters_in_transaction)
-        subject.build
-        expect(subject.object).to be_a demo_class 
-      end
-    end
-  end
-
-  describe 'build_nested' do
-    before do 
-      allow(subject).to receive(:build)
-    end
-
-    it 'sets #requires_save to false' do
-      expect(subject).to receive(:requires_save=).with(false)
-      subject.build_nested
-    end
-
-    it 'calls #build' do
-      expect(subject).to receive(:build)
-      subject.build_nested
-    end
-  end
-
-  describe 'update(object_id:, acting_user=nil' do
-    context 'when the object can\'t be found' do
-      it 'returns an errors hash with the error status 404' do
-        object_class = double(find_by_id: nil)
-        allow(subject).to receive(:object_class) {object_class}
-        result = subject.update(object_id: 0)
-        expect(result[:error_status]).to eq(404) 
-      end
-    end  
-
-    context 'when an object is found' do
-      before do
-        object_class = double(find_by_id: :found_object)
-        allow(subject).to receive(:object_class) {object_class}
-      end
-
-      it 'assigns the found object to the builder\'s object attribute' do
-        expect(subject).to receive(:object=).with(:found_object)
-        subject.update(object_id: 0)
-      end
-
-      it 'calls #assign_parameters_in_transaction' do
-        expect(subject).to receive(:assign_parameters_in_transaction)
-        subject.update(object_id: 0)
-      end
-    end
-  end
-
-  context 'when the params have a root node' do
-    it 'throws an exception' do
-      expect { DemoTestBuilder.new({demo_test: 'gg'}) }.to raise_error
-    end
-  end
-
-  describe '#permitted_attributes' do
-    context 'when the attributes method is called in the class definition with attribute symbols as parameter' do
-      it 'those attribute symbols are available in #permitted_attributes' do
-        expect(DemoTestBuilder.new({}).permitted_attributes).to include :name
-        expect(DemoTestBuilder.new({}).permitted_attributes).to include :content
-      end
-    end
-
-    context 'when params are passed that are not permitted at class definition' do
-      it 'does not include those in the #permitted_attributes' do
-        expect(DemoTestBuilder.new({}).permitted_attributes).to_not include :author
-      end
-    end
-  end 
-
-  describe 'matching param keys to attributes' do
-    let(:unpermitted_params) { {name: 'test params',
-                                content: 'none',
-                                author: 'Jim'} }
-    it 'saves the object' do
-      builder = NoMethodsBuilder.new params
-      builder.build
-      expect(builder.object.saved).to be
-    end
-
-    it 'does not save the object if a param key is included that is not listed as a permitted attribute' do
-      builder = NoMethodsBuilder.new unpermitted_params
-      builder.build
-      expect(builder.object.saved).to_not be
-    end
-
-    context 'when there are no custom methods defined that match param keys' do
-      specify "For each param key that is included in permitted attributes, the value of the param is assigned to the object\'s attribute matching the key name" do
-        builder = NoMethodsBuilder.new params
-        builder.build
-        expect(builder.object.name).to eq(params[:name])
-        expect(builder.object.content).to eq(params[:content])
-        expect(builder.object.author).to_not be 
-      end
-    end
-
-    context 'when there are custom methods defined that match the name of attributes' do
-      specify 'those attributes are not automatically assigned' do
-        builder = MethodsBuilder.new params
-        builder.build
-        expect(builder.object.name).to_not be
-        expect(builder.object.content).to_not be
-        expect(builder.object.author).to_not be 
-      end
-    end
-  end 
-
-  describe '#top_level_array' do
-    let(:array_params) { [params,params] }
-    subject { DemoTestBuilder.new(array_params) }
-
-    context 'when the params contain an array of two objects' do
-      it 'returns two objects' do
-        result = subject.send(:top_level_array)
-        expect(result[0]).to be_a DemoTest 
-        expect(result[1]).to be_a DemoTest 
-      end
-
-      it 'does not save the objects' do
-        result = subject.send(:top_level_array)
-        expect(result[0].saved).to_not be
-      end
-    end
-  end
-
-  describe 'delayed_save!(object)' do
-    it 'adds the object to the #nested_objects_to_save array' do
-      expect(subject.nested_objects_to_save).to be_a Array
-      subject.send(:delayed_save!, :nested_object)
-      expect(subject.nested_objects_to_save).to include :nested_object 
-    end    
-
-    it 'does not add an duplicate object' do
-      expect(subject.nested_objects_to_save.length).to be 0
-      subject.send(:delayed_save!, 'nested_object')
-      subject.send(:delayed_save!, 'nested_object')
-      expect(subject.nested_objects_to_save.length).to be 1
-    end
-  end
-
-  describe 'callbacks' do
-    context 'when the before_save method is used in the class definition' do
-      it 'adds the method symbols passed to the #before_save_callbacks array' do
-        expect(subject.send(:before_save_callbacks)).to match_array [:before_one, :before_two] 
-      end
-    end
-
-    context 'when the after_save method is used in the class definition' do
-      it 'adds the method symbols passed to the #after_save_callbacks array' do
-        expect(subject.send(:after_save_callbacks)).to match_array [:after_one] 
-      end
-    end
-  end
-
-  describe 'building the object' do
-    context '#assign_parameters_in_transaction' do
-
-      context 'when there is a validator assigned' do
-        it 'calls #validate_parameters on the validator' do
-          subject.build
-          expect(subject.validator.validated).to be
-        end
-      end
-
-      context 'when the validator returns errors' do
-        let(:error) { error = {status: 400, code: 'invalid_request_error'} }
-        before { allow(subject.validator).to receive(:errors) { [error] } }
-
-        it 'the method returns early, not calling the following methods' do
-          expect(subject).to_not receive(:top_level_array)  
-        end
-
-        it 'returns an errors hash' do
-          expect(subject.build[:errors]).to be 
-        end
-      end
-
-      it '#calls top_level_array' do
-        expect(subject).to receive(:top_level_array).at_least(:once) 
-        subject.build
-      end
-
-      it 'calls #call_setter_for_each_param_key' do
-        expect(subject).to receive(:assign_parameters_in_transaction).at_least(:once) 
-        subject.build
-      end
-
-      context 'when there are no errors' do  
-        context 'when #requires_save is truthy' do
-          it 'saves the object' do
-            subject.build
-            expect(subject.object.saved).to be 
-          end  
-
-          it 'calls save on all #nested_objects_to_save' do
-            nest1 = double
-            nest2 = double
-            expect(nest1).to receive(:save!)
-            expect(nest2).to receive(:save!)
-            subject.nested_objects_to_save = [ nest1, nest2 ]
-            subject.build
-          end
-
-          it 'calls the #before_save_callbacks before the object is saved' do
-            subject.build
-            expect(subject.object.before_save_called_with_unsaved_object).to be
-          end
-
-          it 'calls @after_save_callbacks after object is saved' do
-            subject.build
-            expect(subject.object.after_save_called_with_saved_object).to be 
-          end
-
-          it 'calls callback blocks after object is saved' do
-            subject = DemoTestBuilder.new(params) { |object| object.block_callback_called_after_save = true if object.saved }
-            subject.build
-            expect(subject.object.block_callback_called_after_save).to be 
-          end
-        end
-        
-        context 'when #requires_save is falsey' do
-          it 'does not save the object' do
-            subject.build_nested
-            expect(subject.object.saved).to_not be 
-          end  
-        end
-      end
-  
-      context 'when there are errors' do
-        
-      end
-    end
-  end
-
-  describe 'self.validator' do
-    context 'when called with a validator class name' do
-      it 'adds that validator to the #validator method' do
-        expect(subject.validator).to be_a DemoParamsValidator 
-      end
-
-      it 'raises an exception if the class given is not a BaseParamsValidator' do
-        
-      end
-    end
-  end
-
-  describe '#validator' do
-    it 'returns a BaseParamsValidator' do
-      expect(subject.validator).to be_a BaseParamsValidator
-    end
-
-    it 'returns an object that responds to #params and returns some data' do
-      expect(subject.validator.params).to be 
-    end
-  end
-end
-
-

data/builder/builder_helper.rb

@@ -1,95 +0,0 @@
-require_relative "../../app/application_services/base_builder"
-require_relative "../../app/application_services/base_params_validator"
-
-class DemoParamsValidator < BaseParamsValidator
-
-  attr_accessor :validated
-
-  def validate_params
-    @validated = true
-    self
-  end
-
-  def errors 
-    []
-  end
-
-end
-
-class DemoTestBuilder < BaseBuilder
-  attributes :name, :content
-  before_save :before_one, :before_two
-  after_save :after_one
-  validator DemoParamsValidator
-
-  def before_one
-    object.before_save_called_with_unsaved_object = true unless object.saved
-  end
-
-  def before_two; end
-
-  def after_one
-    object.after_save_called_with_saved_object = true if object.saved
-  end
-end
-
-class NoMethodsBuilder < BaseBuilder
-  attributes :name, :content
-end
-
-class MethodsBuilder < BaseBuilder
-  attributes :name, :content
-  before_save :before_method
-  after_save :after_method
-  validator DemoParamsValidator
-
-  def name(data); end
-
-  def content(data); end
-
-  def before_method
-    object.before_method_called = true
-  end
-
-  def after_method
-    object.after_method_called = true
-  end
-end
-
-class DemoTest
-  attr_accessor :name, :content, :author
-  attr_reader :saved, :updated
-  attr_accessor :before_method_called, :after_method_called
-  attr_accessor :before_save_called_with_unsaved_object
-  attr_accessor :after_save_called_with_saved_object
-  attr_accessor :block_callback_called_after_save
-
-  def save!
-    @saved = true
-  end
-
-  def update!
-    @updated = true
-  end
-
-  def self.find_by(argument)
-    nil
-  end
-
-  def persisted?
-    false
-  end
-end
-
-class PlainValidator; end
-
-class BadValidatorBuilder < BaseBuilder
-  validator PlainValidator
-end
-
-
-
-#Used so that the buidlers with different names can all use the DemoTest class
-NoMethods = DemoTest
-Methods = DemoTest
-BadValidator = DemoTest