contextualize 0.1.0 → 0.1.1

data/README.textile

@@ -0,0 +1,186 @@
+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.
+
+"Decorator Pattern with Mixology":http://ruby.simapse.com/2008/08/test.html
+
+In a Rails project, you should use the following structure
+
+<pre>
++ app
+  + contexts
+      project_view.rb
+      project_control.rb
+    + admin
+        project_view.rb
+    
+  + models
+    project.rb
+</pre>
+
+Define each context specific module
+
+<pre>
+module ProjectView
+  # display the best project
+  def show_best
+    # calls method :best
+  end
+end
+
+module ProjectControl
+  # select the best project
+  def best
+  end
+end
+
+module Admin
+  module ProjectControl
+    # admin specific logic to select the best project!
+    def best
+    end
+  end
+end
+</pre>
+
+Then bind these modules to one or more contexts 
+
+<pre>
+class Project
+  contextualize
+  icontexts :view, :control # using naming conventions
+  icontext :admin, Admin::ProjectControl
+end
+</pre>
+
+Now you can operate on the object according to the context you are in
+
+<pre>
+project = Project.new
+
+# add :view context
+project.add_icontext :view
+project.add_icontexts :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
+
+
+# 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.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|
+  # ...
+end
+</pre>
+
+h2. Usage in Rails
+
+<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
+
+    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)
+       
+<pre>
+class ProjectsController < ApplicationController
+  expose(:projects) { Project.all }
+  expose(:project)
+
+  def index
+  end
+
+  def show
+  end
+
+  def new
+  end
+
+  def edit
+  end
+
+  def create
+    if project.save
+      redirect_to project, notice: 'Project was successfully created.'
+    else
+      render action: "new"
+    end
+  end
+
+  def update
+    if project.update_attributes(params[:project])
+      redirect_to project, notice: 'Project was successfully updated.'
+    else
+      render action: "edit"
+    end
+  end
+
+  def destroy
+    project.destroy
+    redirect_to projects_url
+  end
+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
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* 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
+
+Copyright (c) 2011 Kristian Mandrup. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/contextualize.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{contextualize}
+  s.version = "0.1.1"
+
+  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.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.textile"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "contextualize.gemspec",
+    "lib/contextualize.rb",
+    "lib/contextualize/core_ext.rb",
+    "lib/contextualize/decent_exposure.rb",
+    "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}
+
+  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<activesupport>, [">= 3.0.1"])
+      s.add_development_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.1"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.3"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<mixology>, ["~> 0.2.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"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.3"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mixology>, ["~> 0.2.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"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.3"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/contextualize.rb

@@ -1,15 +1,20 @@
 require 'mixology'
 require 'active_support/inflector'
 require 'contextualize/core_ext'
+require 'contextualize/decent_exposure'
 
 module Contextualize
-
   module ClassMethods
     attr_reader :icontext_map
 
     def icontext name, *constants
       @icontext_map ||= {}
-      @icontext_map[name.to_sym] = select_modules constants
+      context_modules = if constants.flatten.empty?
+        const_by_convention(name) 
+      else                         
+        select_modules constants
+      end
+      @icontext_map[name.to_sym] = context_modules
     end
 
     def icontexts *names
@@ -22,7 +27,7 @@ module Contextualize
 
     def const_by_convention name
       cls_name = self.name.demodulize
-      const_name = "Contextualize::#{cls_name}#{name.to_s.camelize}"
+      const_name = "#{cls_name}#{name.to_s.camelize}"
       const_name.constantize
     end
 
@@ -41,16 +46,19 @@ module Contextualize
 
   def add_icontexts *names
     names.each {|name| add_icontext(name) }
+    self
   end
 
   def remove_icontexts *names
     names.each {|name| remove_icontext(name) }
+    self
   end
 
   def add_icontext name
     icontext(name).each do |const|
       self.send :mixin, const 
     end
+    self
   end
 
   def remove_icontext name
@@ -58,11 +66,13 @@ module Contextualize
     icontext(name).each do |const|
       self.send :unmix, const
     end
+    self
   end
 
   protected
 
   def icontext name 
-    icontext_map[name.to_sym] || []
+    mods = icontext_map[name.to_sym] || []
+    [mods].flatten
   end  
 end

data/lib/contextualize/core_ext.rb

@@ -10,6 +10,16 @@ class Object
   end
 end
 
+class Array
+  def add_icontext name
+    self.each {|item| item.add_icontext name }
+  end
+
+  def remove_icontext name
+    self.each {|item| item.remove_icontext name }
+  end
+end
+
 class Module
   def contextualize
     self.send :include, Contextualize

data/lib/contextualize/decent_exposure.rb

@@ -0,0 +1,20 @@
+module DecentExposure
+  def expose(name, &block)
+    closured_exposure = default_exposure
+    define_method name do
+      @_resources       ||= {}
+      @_resources[name] ||= if block_given?
+        instance_eval(&block)
+      else
+        instance_exec(name, &closured_exposure)
+      end
+      puts "expose contextualize"
+      @_resources[name].add_icontext :view
+    end
+    helper_method name
+    hide_action name
+  end
+  
+  alias_method :view_expose, :expose
+end
+  

data/spec/contextualize_spec.rb

@@ -1,14 +1,16 @@
 require 'spec_helper'
 
-module ProjectView
+module ProjectViewer
   def view
     "view"
   end
 end
 
-module DetailedView
-  def detailed_view
-    "detailed_view"
+module Admin
+  module ProjectDetailedView
+    def detailed_view
+      "detailed_view"
+    end
   end
 end
 
@@ -19,32 +21,31 @@ module ProjectControl
 end
 
 
-
 class Project
   contextualize
 
-  icontext :view, ProjectView, DetailedView
+  icontext :view, ProjectViewer, Admin::ProjectDetailedView
   icontext :control, ProjectControl
 end
 
-module Contextualize
-  module EventView
-    def view
-      "view"
-    end
+
+module EventView
+  def view
+    "view"
   end
+end
 
-  module EventControl
-    def control
-      "control"
-    end
+module EventControl
+  def control
+    "control"
   end
 end
 
+
 class Event
   contextualize
-
-  icontexts :view, :control
+  icontext  :control
+  icontexts :view
 end
 
 describe "Contextualize" do
@@ -52,9 +53,14 @@ describe "Contextualize" do
     Project.new
   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
+  end
+
   it "can add a context to an object" do
     project.add_icontext :view
-    project.own_methods.should include('view')
+    project.own_methods.should include(:view)
 
     project.view.should == "view"
     project.detailed_view.should == "detailed_view"
@@ -62,7 +68,7 @@ describe "Contextualize" do
 
   it "can remove a context from an object" do
     project.add_icontext :view  
-    project.own_methods.should include('view')
+    project.own_methods.should include(:view)
 
     project.remove_icontext :view
     lambda {project.view}.should raise_error
@@ -78,6 +84,16 @@ describe "Contextualize" do
     lambda {project.control}.should raise_error
   end
 
+  describe 'Array extension' do
+    let (:events) do
+      [Event.new, Event.new].add_icontext :view
+    end
+
+    it 'should work on an Array instance' do
+      events.first.own_methods.should include(:view)
+    end    
+  end
+
   describe 'naming conventions' do
     let (:event) do
       Event.new
@@ -85,9 +101,11 @@ describe "Contextualize" do
 
     it 'should apply naming conventions' do
       event.add_icontext :view
-      event.own_methods.should include('view')
-
+      event.own_methods.should include(:view)
       event.view.should == "view"
+
+      event.add_icontext :control
+      event.own_methods.should include(:control)
     end
   end
 end

metadata

@@ -1,170 +1,132 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: contextualize
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.1.1
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Kristian Mandrup
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-04 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2011-07-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixology
+  requirement: &2154964500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 0
-        - 2
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.2.0
-  version_requirements: *id001
   type: :runtime
-  name: mixology
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2154964500
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2154964020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 3
-        - 0
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.1
-  version_requirements: *id002
   type: :runtime
-  name: activesupport
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2154964020
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2154980680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 3
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.3.0
-  version_requirements: *id003
   type: :development
-  name: rspec
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2154980680
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2154980200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 0
-        - 1
+      - !ruby/object:Gem::Version
         version: 1.0.1
-  version_requirements: *id004
   type: :development
-  name: bundler
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2154980200
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2154979720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 6
-        - 3
+      - !ruby/object:Gem::Version
         version: 1.6.3
-  version_requirements: *id005
   type: :development
-  name: jeweler
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2154979720
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2154979240 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id006
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: rcov
   prerelease: false
-description: Add and remove behaviors defined in modules depending on context an object operates in
+  version_requirements: *2154979240
+description: Add and remove behaviors defined in modules depending on context an object
+  operates in
 email: kmandrup@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
-files: 
+- README.textile
+files:
 - .document
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
+- contextualize.gemspec
 - lib/contextualize.rb
 - lib/contextualize/core_ext.rb
+- lib/contextualize/decent_exposure.rb
 - spec/contextualize_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/kristianmandrup/contextualize
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -4138437113857599099
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Contextual behaviors for objects for use with Rails models and many other scenarios
+summary: Contextual behaviors for objects for use with Rails models and many other
+  scenarios
 test_files: []
-

data/README.rdoc

@@ -1,73 +0,0 @@
-= 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
-
-+ models
-    project
-    + contextualize
-      project_view.rb
-      project_control.rb
-      + admin
-        project_view.rb
-
-module Contextualize::ProjectView
-  def full_name
-  end
-end
-
-module Contextualize::ProjectControl
-  def best
-  end
-end
-
-
-class Project
-  contextualize
-  icontexts :view, :control # using naming conventions
-  icontext :admin, Contextualize::Admin::ProjectView
-end
-
-project = Project.new
-
-# add :view context
-project.add_icontext :view
-
-# 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
-
-# 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.view.should == "view"
-end
-
-# contexts are automatically removed from object when block terminates
-lambda {project.view}.should raise_error
-
-
-== 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
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* 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
-
-Copyright (c) 2011 Kristian Mandrup. See LICENSE.txt for
-further details.
-