contextualize 0.1.1 → 0.2.0

data/Gemfile

@@ -1,6 +1,7 @@
 source "http://rubygems.org"
 
 gem "mixology",      "~> 0.2.0"
+gem "i18n"
 gem "activesupport", ">= 3.0.1"
 
 # Add dependencies to develop your gem here.

data/Gemfile.lock

@@ -4,6 +4,7 @@ GEM
     activesupport (3.0.9)
     diff-lcs (1.1.2)
     git (1.2.5)
+    i18n (0.6.0)
     jeweler (1.6.3)
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -26,6 +27,7 @@ PLATFORMS
 DEPENDENCIES
   activesupport (>= 3.0.1)
   bundler (~> 1.0.1)
+  i18n
   jeweler (~> 1.6.3)
   mixology (~> 0.2.0)
   rcov

data/README.textile

@@ -1,27 +1,18 @@
-h1. contextualize
+h1. Contextualize
 
 Adds the ability to add and remove specific modules to an object depending on the current context
 This can fx be used for Models in a _MVC_ pattern, where the model could have different behavior 
 depending on the context it operates in, fx if is currently accessed in a _View_ or a _Controller_, or
-even depending on the scope (fx Admin) etc. This way, a lot of the typical scenarios for helper methods
-can be avoided, and instead you simply create scope folders for the model, typically one for view and 
-possibly one for controller.
+even depending on the scope (fx Admin) etc.
 
-"Decorator Pattern with Mixology":http://ruby.simapse.com/2008/08/test.html
+This way, a lot of the typical scenarios for helper methods can be avoided. Instead you simply create 
+an 'app/contexts' folder for modules that define contextual behavior for the models. You can further
+subdivision these contexts as needed. This can even be used to redefine the logic of a method depending 
+on the context it operates in.
 
-In a Rails project, you should use the following structure
+The "Decorator Pattern with Mixology":http://ruby.simapse.com/2008/08/test.html has been used to great effect.
 
-<pre>
-+ app
-  + contexts
-      project_view.rb
-      project_control.rb
-    + admin
-        project_view.rb
-    
-  + models
-    project.rb
-</pre>
+h2. Basic Usage
 
 Define each context specific module
 
@@ -46,6 +37,13 @@ module Admin
     end
   end
 end
+
+# Only in order to faciliatet demonstrating results below!
+class Object
+  def own_methods
+    methods - Object.methods
+  end
+end
 </pre>
 
 Then bind these modules to one or more contexts 
@@ -53,8 +51,8 @@ Then bind these modules to one or more contexts
 <pre>
 class Project
   contextualize
-  icontexts :view, :control # using naming conventions
-  icontext :admin, Admin::ProjectControl
+  contexts :view, :control # using naming conventions
+  context :admin, Admin::ProjectControl
 end
 </pre>
 
@@ -64,68 +62,94 @@ Now you can operate on the object according to the context you are in
 project = Project.new
 
 # add :view context
-project.add_icontext :view
-project.add_icontexts :view, :control
+project.add_context :view
+project.add_contexts :view, :control
 
 # use the view context methods now available
 project.own_methods.should include('view')
 project.view.should == "view"
- 
+
 # remove the :view context
-project.remove_icontext :view
-project.remove_icontexts :view, :control
+project.remove_context :view
+project.remove_contexts :view, :control
 
 
 # the methods of the view context are no longer available!
 lambda {project.view}.should raise_error
 
 # operate on object within one or more contexts
-project.icontext_scope :view do |project|
+project.context_scope :view do |project|
   project.view.should == "view"
 end
 
 # contexts are automatically removed from object when block terminates
 lambda {project.view}.should raise_error
 
-project.icontext_scope :view, :control do |project|
+project.context_scope :view, :control do |project|
   # ...
 end
 </pre>
 
 h2. Usage in Rails
 
+in Gemfile
+
 <pre>
-  class ProjectsController < ApplicationController
-    # "simulated" exposure
-    def project
-      @project ||= begin
-        p = params[:id] ? Project.find(params[:id]) : Project.new(params[:project])
-        p.add_icontext :view
-      end
-    end
-    helper_method project
-    hide_action project
+gem 'contextualize'
+</pre>
 
-    def projects
-      @projects ||= Project.all.add_icontext :view
-    end
-    helper_method projects
-    hide_action projects
+In a Rails project, you should use the following file structure
 
-    def index
-    end
+<pre>
++ app
+  + contexts
+      project_view.rb
+      project_control.rb
+    + admin
+        project_view.rb
+
+  + models
+    project.rb
+</pre>
 
-    def show
+<pre>
+class ProjectsController < ApplicationController
+  # "simulated" exposure
+  def project
+    @project ||= begin
+      p = params[:id] ? Project.find(params[:id]) : Project.new(params[:project])
+      p.add_icontext :view
     end
-    
-    ...
-  end  
+  end
+  helper_method project
+  hide_action project
+
+  def projects
+    @projects ||= Project.all.add_icontext :view
+  end
+  helper_method projects
+  hide_action projects
+
+  def index
+  end
+
+  def show
+  end
+  ...
+end
 </pre>
 
 h2. Using decent_exposure integration
 
 Contextualize monkey-patches the _#expose_ method of the _decent_exposure_ gem to add the icontext :view to each model (if present)
-       
+
+in Gemfile
+
+<pre>
+gem 'decent_exposure'
+gem 'contextualize'
+</pre>
+
 <pre>
 class ProjectsController < ApplicationController
   expose(:projects) { Project.all }
@@ -166,11 +190,10 @@ class ProjectsController < ApplicationController
 end
 </pre>
 
-
 Enjoy!
 
 h2. Contributing to contextualize
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -179,7 +202,7 @@ h2. Contributing to contextualize
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+h2. Copyright
 
 Copyright (c) 2011 Kristian Mandrup. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/contextualize.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{contextualize}
-  s.version = "0.1.1"
+  s.name = "contextualize"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Kristian Mandrup}]
-  s.date = %q{2011-07-05}
-  s.description = %q{Add and remove behaviors defined in modules depending on context an object operates in}
-  s.email = %q{kmandrup@gmail.com}
+  s.authors = ["Kristian Mandrup"]
+  s.date = "2011-09-21"
+  s.description = "Add and remove behaviors defined in modules depending on context an object operates in"
+  s.email = "kmandrup@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.textile"
@@ -32,17 +32,18 @@ Gem::Specification.new do |s|
     "spec/contextualize_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/kristianmandrup/contextualize}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.5}
-  s.summary = %q{Contextual behaviors for objects for use with Rails models and many other scenarios}
+  s.homepage = "http://github.com/kristianmandrup/contextualize"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Contextual behaviors for objects for use with Rails models and many other scenarios"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<mixology>, ["~> 0.2.0"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 3.0.1"])
       s.add_development_dependency(%q<rspec>, [">= 2.3.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.1"])
@@ -50,6 +51,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<mixology>, ["~> 0.2.0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 3.0.1"])
       s.add_dependency(%q<rspec>, [">= 2.3.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.1"])
@@ -58,6 +60,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<mixology>, ["~> 0.2.0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
     s.add_dependency(%q<activesupport>, [">= 3.0.1"])
     s.add_dependency(%q<rspec>, [">= 2.3.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.1"])

data/lib/contextualize.rb

@@ -5,21 +5,21 @@ require 'contextualize/decent_exposure'
 
 module Contextualize
   module ClassMethods
-    attr_reader :icontext_map
+    attr_reader :context_map
 
-    def icontext name, *constants
-      @icontext_map ||= {}
+    def context name, *constants
+      @context_map ||= {}
       context_modules = if constants.flatten.empty?
-        const_by_convention(name) 
-      else                         
+        const_by_convention(name)
+      else
         select_modules constants
       end
-      @icontext_map[name.to_sym] = context_modules
+      @context_map[name.to_sym] = context_modules
     end
 
-    def icontexts *names
+    def contexts *names
       names.flatten.each do |name|
-        icontext name, const_by_convention(name)
+        context name, const_by_convention(name)
       end
     end
 
@@ -40,39 +40,43 @@ module Contextualize
     base.extend ClassMethods
   end
 
-  def icontext_map
-    self.class.icontext_map || {}
+  def context_map
+    self.class.context_map || {}
   end
 
-  def add_icontexts *names
-    names.each {|name| add_icontext(name) }
+  def add_contexts *names
+    names.each {|name| add_context(name) }
     self
   end
+  alias_method :enter_contexts, :add_contexts
 
-  def remove_icontexts *names
-    names.each {|name| remove_icontext(name) }
+  def remove_contexts *names
+    names.each {|name| remove_context(name) }
     self
   end
+  alias_method :exit_contexts, :remove_contexts
 
-  def add_icontext name
-    icontext(name).each do |const|
-      self.send :mixin, const 
+  def add_context name
+    context(name).each do |const|
+      self.send :mixin, const
     end
     self
   end
+  alias_method :enter_context, :add_context
 
-  def remove_icontext name
-    return if !icontext(name) || icontext(name).empty? 
-    icontext(name).each do |const|
+  def remove_context name
+    return if !context(name) || context(name).empty? 
+    context(name).each do |const|
       self.send :unmix, const
     end
     self
   end
+  alias_method :exit_context, :remove_context
 
   protected
 
-  def icontext name 
-    mods = icontext_map[name.to_sym] || []
+  def context name
+    mods = context_map[name.to_sym] || []
     [mods].flatten
-  end  
+  end
 end

data/lib/contextualize/core_ext.rb

@@ -1,22 +1,18 @@
 class Object
-  def own_methods
-    methods - Object.methods
-  end
-
-  def icontext_scope *names, &block
-    self.add_icontexts *names
+  def context_scope *names, &block
+    self.add_contexts *names
     yield self if block
-    self.remove_icontexts *names
+    self.remove_contexts *names
   end
 end
 
 class Array
-  def add_icontext name
-    self.each {|item| item.add_icontext name }
+  def add_context name
+    self.each {|item| item.add_context name }
   end
 
-  def remove_icontext name
-    self.each {|item| item.remove_icontext name }
+  def remove_context name
+    self.each {|item| item.remove_context name }
   end
 end
 
@@ -24,10 +20,6 @@ class Module
   def contextualize
     self.send :include, Contextualize
   end
-
-  def own_methods
-    instance_methods - Object.instance_methods
-  end
 end
 
 

data/lib/contextualize/decent_exposure.rb

@@ -8,13 +8,12 @@ module DecentExposure
       else
         instance_exec(name, &closured_exposure)
       end
-      puts "expose contextualize"
-      @_resources[name].add_icontext :view
+      @_resources[name].add_context :view
     end
     helper_method name
     hide_action name
   end
-  
+
   alias_method :view_expose, :expose
 end
-  
+

data/spec/contextualize_spec.rb

@@ -24,8 +24,8 @@ end
 class Project
   contextualize
 
-  icontext :view, ProjectViewer, Admin::ProjectDetailedView
-  icontext :control, ProjectControl
+  context :view, ProjectViewer, Admin::ProjectDetailedView
+  context :control, ProjectControl
 end
 
 
@@ -41,11 +41,16 @@ module EventControl
   end
 end
 
+class Object
+  def own_methods
+    methods - Object.methods
+  end
+end
 
 class Event
   contextualize
-  icontext  :control
-  icontexts :view
+  context  :control
+  contexts :view
 end
 
 describe "Contextualize" do
@@ -54,12 +59,12 @@ describe "Contextualize" do
   end
 
   it "gracefully handles adding an invalid context to an object without raising error" do
-    lambda {project.add_icontext :blip}.should_not raise_error
-    lambda {project.remove_icontext :blip}.should_not raise_error
+    lambda {project.add_context :blip}.should_not raise_error
+    lambda {project.remove_context :blip}.should_not raise_error
   end
 
   it "can add a context to an object" do
-    project.add_icontext :view
+    project.add_context :view
     project.own_methods.should include(:view)
 
     project.view.should == "view"
@@ -67,16 +72,16 @@ describe "Contextualize" do
   end
 
   it "can remove a context from an object" do
-    project.add_icontext :view  
+    project.add_context :view
     project.own_methods.should include(:view)
 
-    project.remove_icontext :view
+    project.remove_context :view
     lambda {project.view}.should raise_error
     lambda {project.detailed_view}.should raise_error
   end
 
   it 'can operate in a context scope' do
-    project.icontext_scope :view, :control do |project|
+    project.context_scope :view, :control do |project|
       project.view.should == "view"
       project.control.should == "control"
     end
@@ -86,12 +91,12 @@ describe "Contextualize" do
 
   describe 'Array extension' do
     let (:events) do
-      [Event.new, Event.new].add_icontext :view
+      [Event.new, Event.new].add_context :view
     end
 
     it 'should work on an Array instance' do
       events.first.own_methods.should include(:view)
-    end    
+    end
   end
 
   describe 'naming conventions' do
@@ -100,12 +105,15 @@ describe "Contextualize" do
     end
 
     it 'should apply naming conventions' do
-      event.add_icontext :view
+      event.enter_context :view
       event.own_methods.should include(:view)
       event.view.should == "view"
 
-      event.add_icontext :control
+      event.enter_context :control
       event.own_methods.should include(:control)
+
+      event.exit_context :control
+      event.own_methods.should_not include(:control)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contextualize
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-05 00:00:00.000000000Z
+date: 2011-09-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixology
-  requirement: &2154964500 !ruby/object:Gem::Requirement
+  requirement: &2163328980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *2154964500
+  version_requirements: *2163328980
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &2163328500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2163328500
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2154964020 !ruby/object:Gem::Requirement
+  requirement: &2163328020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2154964020
+  version_requirements: *2163328020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2154980680 !ruby/object:Gem::Requirement
+  requirement: &2163327540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2154980680
+  version_requirements: *2163327540
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2154980200 !ruby/object:Gem::Requirement
+  requirement: &2163327060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +65,10 @@ dependencies:
         version: 1.0.1
   type: :development
   prerelease: false
-  version_requirements: *2154980200
+  version_requirements: *2163327060
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2154979720 !ruby/object:Gem::Requirement
+  requirement: &2163326580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +76,10 @@ dependencies:
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2154979720
+  version_requirements: *2163326580
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2154979240 !ruby/object:Gem::Requirement
+  requirement: &2163326100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154979240
+  version_requirements: *2163326100
 description: Add and remove behaviors defined in modules depending on context an object
   operates in
 email: kmandrup@gmail.com
@@ -115,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4138437113857599099
+      hash: -898150994270880704
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -124,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Contextual behaviors for objects for use with Rails models and many other