yeti 0.1.1 → 0.1.2

data/README.md

@@ -20,7 +20,153 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Yeti::Context
+
+The context object allows to communicate application state coming from the
+controllers. First, let's create a Context class tuned to your application
+logic.
+
+```ruby
+class Context < Yeti::Context
+  def initialize(hash)
+    super hash
+    @section = hash.fetch :section
+  end
+
+  def in_admin?
+    section==:admin
+
+  def api_call?
+    section==:api
+  end
+end
+```
+
+Typical usage in controller:
+
+```ruby
+class Admin::BaseController < ApplicationController
+private
+  def current_context
+    Context.new account_id: session[:account_id, section: :admin
+  end
+end
+class Admin::UsersController < Admin::BaseController
+  def index
+    @users = UserSearch.new context, params
+  end
+
+  def show
+    @user = UserViewer.new context, params[:id]
+  end
+
+  def new
+    user
+  end
+
+  def create
+    if user.update_attributes params[:user]
+      redirect_to action: :index, notice: t(:successfully_created)
+    else
+      flash.now[:error] = t(:please_fix_errors_and_retry)
+      render :new
+    end
+  end
+
+  def edit
+    user
+  end
+
+  def update
+    if user.update_attributes params[:user]
+      redirect_to action: :index, notice: t(:successfully_updated)
+    else
+      flash.now[:error] = t(:please_fix_errors_and_retry)
+      render :edit
+    end
+  end
+
+  def user
+    @user ||= UserEditor.new context, params[:id]
+  end
+end
+```
+
+The presenters can then use the context to restrict search results, change
+validation, etc. The context object is also useful to track current account in
+order to apply permissions or know who is performing the action.
+
+Let's say you have a Account model:
+
+```ruby
+class Account < ActiveRecord::Base
+  def guest?
+    false
+  end
+end
+```
+
+of course it could be using Sequel, Mongoid or the ORM of your liking. Then you
+can define your context class this way:
+
+```ruby
+class Context < Yeti::Context
+  class NoAccount < Yeti::Context::NoAccount
+    def guest?
+      true
+    end
+  end
+  delegate :guest?, to: :account
+
+private
+
+  def find_account_by_id(id)
+    Account.find_by_id id
+  end
+
+  def no_account
+    NoAccount.new
+  end
+end
+```
+
+And with that setup you get:
+
+```ruby
+existing_account_id = 1
+invalid_id = 2
+Context.new.guest? #=> true
+Context.new(account_id: existing_account_id).guest? #=> false
+Context.new(account_id: invalid_id).guest? #=> true
+```
+
+No more passing tons of variables from presenters to presenters, the context
+object regroups and unify this communication while being easy to test in
+isolation.
+
+### Yeti::Search
+
+The search object aims to simplify creating pages with numerous filters.
+
+Let's say you have the following Sequel model:
+
+```ruby
+class User < Sequel::Model
+end
+```
+
+then you can create UserSearch like this:
+
+```ruby
+class UserSearch < Yeti::Search
+private
+  def paginated_results
+    User.search(search).paginate page, per_page
+  end
+end
+```
+
+### Yeti::Editor
 
 ## Contributing
 

data/lib/yeti/context.rb

@@ -6,13 +6,15 @@ module Yeti
 
     delegate :id, to: :account, prefix: :account
 
-    def initialize(hash)
-      @given_account_id = hash.fetch(:account_id)
+    def initialize(hash={})
+      @hash = hash
     end
 
     def account
-      @account ||= find_account_by_id given_account_id if given_account_id
-      @account ||= no_account
+      @account ||= begin
+        given_account_id = hash[:account_id]
+        (find_account_by_id given_account_id if given_account_id) || no_account
+      end
     end
 
     def find_account_by_id(id)
@@ -21,7 +23,7 @@ module Yeti
 
   private
 
-    attr_reader :given_account_id
+    attr_reader :hash
 
     def no_account
       NoAccount.new

data/lib/yeti/editor.rb

@@ -6,7 +6,7 @@ module Yeti
     attr_reader :context
     delegate :id, to: :edited
 
-    def initialize(context, given_id)
+    def initialize(context, given_id=nil)
       @context = context
       @given_id = given_id
     end

data/lib/yeti/version.rb

@@ -1,3 +1,3 @@
 module Yeti
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/yeti/context_spec.rb

@@ -1,10 +1,14 @@
 require "spec_helper"
 
 describe Yeti::Context do
-  context "initialization" do
-    it "requires a hash with account_id" do
-      lambda{ Yeti::Context.new }.should raise_error ArgumentError, "wrong number of arguments (0 for 1)"
-      lambda{ Yeti::Context.new key: nil }.should raise_error KeyError, "key not found: :account_id"
+  context "without hash" do
+    it "#account is an instance of Yeti::Context::NoAccount" do
+      Yeti::Context.new.account.should be_kind_of Yeti::Context::NoAccount
+    end
+  end
+  context "when account_id is not in hash" do
+    it "#account is an instance of Yeti::Context::NoAccount" do
+      Yeti::Context.new({}).account.should be_kind_of Yeti::Context::NoAccount
     end
   end
   context "when account_id is nil" do

data/spec/yeti/editor_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe Yeti::Editor do
   let(:context){ mock :context }
-  subject{ Yeti::Editor.new context, nil }
+  subject{ Yeti::Editor.new context }
   it "keeps given context" do
     subject.context.should be context
   end
@@ -23,6 +23,14 @@ describe Yeti::Editor do
       subject.edited.should be expected
     end
   end
+  context "with id nil" do
+    subject{ Yeti::Editor.new context, nil }
+    it{ should_not be_persisted }
+    it "uses #new_object to initialize main object being edited" do
+      subject.stub(:new_object).and_return(expected = mock)
+      subject.edited.should be expected
+    end
+  end
   context "without id" do
     it{ should_not be_persisted }
     it "uses #new_object to initialize main object being edited" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yeti
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-20 00:00:00.000000000 Z
+date: 2012-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -114,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -488456883026859265
+      hash: 3542103795249747171
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -488456883026859265
+      hash: 3542103795249747171
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24