yeti 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yeti.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Joseph HALTER
+
+MIT License
+
+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.md

@@ -0,0 +1,31 @@
+# Yeti
+
+Yeti: Context, Editor and Search patterns
+
+Editor pattern simplifies edition of multiple objects at once using ActiveModel
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yeti'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yeti
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/yeti.rb

@@ -0,0 +1,7 @@
+require "active_model"
+require "string_cleaner"
+require "yeti/context"
+require "yeti/errors"
+require "yeti/editor"
+require "yeti/search"
+require "yeti/version"

data/lib/yeti/context.rb

@@ -0,0 +1,28 @@
+module Yeti
+  class Context
+    class NoAccount
+      attr_reader :id
+    end
+
+    def initialize(hash)
+      @given_account_id = hash.fetch(:account_id)
+    end
+
+    def account
+      @account ||= find_account_by_id(given_id) || no_account
+    end
+
+    def find_account_by_id(id)
+      raise NotImplementedError
+    end
+
+  private
+
+    attr_reader :given_account_id
+
+    def no_account
+      NoAccount.new
+    end
+
+  end
+end

data/lib/yeti/editor.rb

@@ -0,0 +1,109 @@
+module Yeti
+  class Editor
+    include ActiveModel::Validations
+    include ActiveModel::Dirty
+
+    attr_reader :context
+    delegate :id, to: :edited
+
+    def initialize(context, given_id)
+      @context = context
+      @given_id = given_id
+    end
+
+    def errors
+      @errors ||= ::Yeti::Errors.new(
+        self,
+        untranslated: self.class.untranslated?
+      )
+    end
+
+    def edited
+      @edited ||= if given_id
+        find_by_id given_id.to_i
+      else
+        new_object
+      end
+    end
+
+    def find_by_id(id)
+      raise NotImplementedError
+    end
+
+    def new_object
+      raise NotImplementedError
+    end
+
+    def persisted?
+      !!given_id
+    end
+
+    def update_attributes(attrs)
+      self.attributes = attrs
+      save
+    end
+
+    def attributes
+      attributes = {}
+      self.class.attributes.each do |key|
+        attributes[key] = send key
+      end
+      attributes
+    end
+
+    def attributes=(attrs)
+      self.class.attributes.each do |key|
+        self.send "#{key}=", attrs[key] if attrs.has_key? key
+      end
+    end
+
+    def save
+      return false unless valid?
+      persist!
+      @previously_changed = changes
+      changed_attributes.clear
+      true
+    end
+
+    def persist!
+      raise NotImplementedError
+    end
+
+  private
+
+    attr_reader :given_id
+
+    def self.attribute(name, opts={})
+      self.attributes << name
+      define_attribute_methods attributes
+      from = opts[:from] || :edited
+      class_eval """
+        def #{name}
+          @#{name} = #{from}.#{name} unless defined? @#{name}
+          @#{name}
+        end
+        def #{name}=(value)
+          value = (value.to_s.clean.strip if value)
+          return if value==#{name}
+          #{name}_will_change!
+          @#{name} = value
+          original_value = changed_attributes[\"#{name}\"]
+          changed_attributes.delete \"#{name}\" if value==original_value
+        end
+      """
+    end
+
+    def self.attributes
+      @attributes ||= []
+    end
+
+    def self.dont_translate_error_messages
+      @untranslated = true
+    end
+
+    def self.untranslated?
+      !!@untranslated
+    end
+
+  end
+end

data/lib/yeti/errors.rb

@@ -0,0 +1,25 @@
+module Yeti
+  class Errors < ::ActiveModel::Errors
+
+      def initialize(base, opts={})
+        super base
+        @untranslated = opts.fetch :untranslated, false
+      end
+
+      def untranslated?
+        @untranslated
+      end
+
+    private
+
+      def normalize_message(attribute, message, options)
+        message ||= :invalid
+        if untranslated? && !message.is_a?(Proc)
+          message
+        else
+          super
+        end
+      end
+
+  end
+end

data/lib/yeti/search.rb

@@ -0,0 +1,55 @@
+module Yeti
+  class Search
+
+    attr_reader :search, :page
+    delegate :to_ary, :empty?, :each, :group_by, :size, to: :results
+
+    def initialize(context, hash)
+      @context = context
+      @search = hash[:search] || {}.with_indifferent_access
+      @page = hash[:page] || 1
+      @per_page = hash[:per_page] || 20
+    end
+
+    def page_count
+      paginated_results.page_count
+    end
+
+    def count
+      paginated_results.pagination_record_count
+    end
+
+    def results
+      paginated_results.all
+    end
+
+    def respond_to?(method)
+      super || method.to_s=~delegate_to_search_pattern
+    end
+
+    def method_missing(method, *args, &block)
+      case method.to_s
+      when /_id_equals\z/
+        search[method].to_i
+      when delegate_to_search_pattern
+        search[method]
+      else
+        super
+      end
+    end
+
+  private
+
+    attr_reader :context, :per_page
+
+    # ~~~ private instance methods ~~~
+    def delegate_to_search_pattern
+      /(?:_equals|_contains|_gte|_lte)\z/
+    end
+
+    def paginated_results
+      raise NotImplementedError
+    end
+
+  end
+end

data/lib/yeti/version.rb

@@ -0,0 +1,3 @@
+module Yeti
+  VERSION = "0.1.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "bundler/setup"
+require "logger"
+require "yeti"
+
+RSpec.configure do |config|
+  config.before(:all) do
+    logger = Logger.new "test.log"
+  end
+end

data/spec/yeti/editor_spec.rb

@@ -0,0 +1,151 @@
+require "spec_helper"
+
+describe ::Yeti::Editor do
+  let(:context){ mock :context }
+  subject{ ::Yeti::Editor.new context, nil }
+  it "should keep given context" do
+    subject.context.should be context
+  end
+  it "#find_by_id should be virtual" do
+    lambda{ subject.find_by_id 1 }.should raise_error NotImplementedError
+  end
+  it "#new_object should be virtual" do
+    lambda{ subject.new_object }.should raise_error NotImplementedError
+  end
+  it "#persist! should be virtual" do
+    lambda{ subject.persist! }.should raise_error NotImplementedError
+  end
+  context "with a given id" do
+    subject{ ::Yeti::Editor.new context, 1 }
+    it{ should be_persisted }
+    it "#edited should use #find_by_id" do
+      subject.stub(:find_by_id).with(1).and_return(expected = mock)
+      subject.edited.should be expected
+    end
+  end
+  context "without id" do
+    it{ should_not be_persisted }
+    it "#edited should use #new_object" do
+      subject.stub(:new_object).and_return(expected = mock)
+      subject.edited.should be expected
+    end
+  end
+  context "when not valid" do
+    before{ subject.stub(:valid?).and_return false }
+    it "#save should return false" do
+      subject.save.should be false
+    end
+  end
+  context "when valid" do
+    it "#save should call persist! then return true" do
+      subject.should_receive :persist!
+      subject.save.should be true
+    end
+  end
+  context "editor of one record" do
+    let :object_editor do
+      Class.new ::Yeti::Editor do
+        attribute :name
+        validates_presence_of :name
+        def self.name
+          "ObjectEditor"
+        end
+      end
+    end
+    context "new record" do
+      subject{ object_editor.new context, nil }
+      let(:new_record){ mock :new_record, name: nil, id: nil }
+      before{ subject.stub(:new_object).and_return new_record }
+      its(:id){ should be_nil }
+      its(:name){ should be_nil }
+      it "#name= should convert input to string" do
+        subject.name = ["test"]
+        subject.name.should == "[\"test\"]"
+      end
+      it "#name= should clean the value" do
+        subject.name = "\tInfected\210\004"
+        subject.name.should == "Infected"
+      end
+      it "#name= should accept nil" do
+        subject.name = "Valid"
+        subject.name = nil
+        subject.name.should be_nil
+      end
+      it "#attributes should return a hash" do
+        subject.attributes.should == {name: nil}
+      end
+      it "#attributes= should assign each attribute" do
+        subject.should_receive(:name=).with "Anthony"
+        subject.attributes = {name: "Anthony"}
+      end
+      it "#attributes= should skip unknown attributes" do
+        subject.attributes = {unknown: "Anthony"}
+      end
+      context "before validation" do
+        its(:errors){ should be_empty }
+      end
+      context "after validation" do
+        it "should have an error on name" do
+          subject.valid?
+          subject.errors[:name].should have(1).item
+          subject.errors[:name].should == ["can't be blank"]
+        end
+        it "should be able to return untranslated error messages" do
+          object_editor.class_eval do
+            dont_translate_error_messages
+          end
+          subject.valid?
+          subject.errors[:name].should == [:blank]
+        end
+      end
+      context "when name is empty" do
+        it{ should_not be_valid }
+      end
+      context "when name is changed" do
+        before{ subject.name = "Anthony" }
+        it{ should be_valid }
+        it "#attributes should be updated" do
+          subject.attributes.should == {name: "Anthony"}
+        end
+        it("name should be updated"){ subject.name.should == "Anthony" }
+        it("name should be dirty"){ subject.name_changed?.should be true }
+        it "name should not be dirty anymore if original value is reset" do
+          subject.name = nil
+          subject.name_changed?.should be false
+        end
+      end
+      context "after save" do
+        before do
+          subject.name = "Anthony"
+          subject.stub :persist!
+          subject.save
+        end
+        it "should reset dirty attributes" do
+          subject.name_changed?.should be false
+        end
+        it "should still know previous changes" do
+          subject.previous_changes.should == {"name"=>[nil, "Anthony"]}
+        end
+      end
+    end
+    context "existing record" do
+      subject{ object_editor.new context, 1 }
+      let(:existing_record){ mock :existing_record, name: "Anthony", id: 1 }
+      before{ subject.stub(:find_by_id).with(1).and_return existing_record }
+      it("should get id from record"){ subject.id.should be 1 }
+      it "should get name from record" do
+        subject.name.should == "Anthony"
+      end
+      it{ should be_valid }
+      context "when name is changed" do
+        before{ subject.name = nil }
+        it("name should be updated"){ subject.name.should be_nil }
+        it("name should be dirty"){ subject.name_changed?.should be true }
+        it "name should not be dirty anymore if original value is reset" do
+          subject.name = "Anthony"
+          subject.name_changed?.should be false
+        end
+      end
+    end
+  end
+end

data/spec/yeti_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Yeti do
+  it "version should be defined" do
+    lambda{ Yeti::VERSION }.should_not raise_error NameError
+  end
+end

data/yeti.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yeti/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "yeti"
+  gem.version       = Yeti::VERSION
+  gem.authors       = ["Joseph HALTER"]
+  gem.email         = ["joseph@openhood.com"]
+  gem.description   = %q{Yeti: Context, Editor and Search patterns}
+  gem.summary       = %q{Editor pattern simplifies edition of multiple objects
+                      at once using ActiveModel}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "activemodel"
+  gem.add_runtime_dependency "string_cleaner"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: yeti
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joseph HALTER
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: string_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Yeti: Context, Editor and Search patterns'
+email:
+- joseph@openhood.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yeti.rb
+- lib/yeti/context.rb
+- lib/yeti/editor.rb
+- lib/yeti/errors.rb
+- lib/yeti/search.rb
+- lib/yeti/version.rb
+- spec/spec_helper.rb
+- spec/yeti/editor_spec.rb
+- spec/yeti_spec.rb
+- yeti.gemspec
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: 955757267782825945
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 955757267782825945
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Editor pattern simplifies edition of multiple objects at once using ActiveModel
+test_files:
+- spec/spec_helper.rb
+- spec/yeti/editor_spec.rb
+- spec/yeti_spec.rb