sheriff 0.0.1 → 0.0.2

data/.pairs

@@ -0,0 +1,9 @@
+# .pairs - configuration for 'git pair'
+# place in project or home directory
+pairs:
+  an: Anthony Navarre
+  jt: Jesse Trimble
+email:
+  prefix: pair
+  domain: anthonynavarre.com
+

data/Gemfile

@@ -1,13 +1,12 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
+gem 'cancan', '1.5.1'
+
 group :development do
   gem "shoulda", ">= 0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"
+  gem 'redgreen', '1.2.2'
+  gem 'test-unit', '2.1.2'
 end

data/Gemfile.lock

@@ -1,6 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    cancan (1.5.1)
     git (1.2.5)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
@@ -8,13 +9,18 @@ GEM
       rake
     rake (0.8.7)
     rcov (0.9.9)
+    redgreen (1.2.2)
     shoulda (2.11.3)
+    test-unit (2.1.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0.0)
+  cancan (= 1.5.1)
   jeweler (~> 1.5.2)
   rcov
+  redgreen (= 1.2.2)
   shoulda
+  test-unit (= 2.1.2)

data/ROADMAP.md

@@ -0,0 +1,60 @@
+TODOS:
+=============================
+
+* Make callstack inspection less brittle by checking ancestry, etc.
+* MOAR CanCan!!1!
+* Support for different frameworks (refactor as Rack app?):
+  * Rails
+  * Sinatra
+
+Ideal End-user API:
+=============================
+
+    # app/controllers/users_controller.rb
+
+    class UsersController < ApplicationController
+
+      def show
+        if FeatureSet(:feature_name).visible?
+          # do something
+        end
+      end
+
+    end
+
+    # app/views/users/show.html.haml
+
+    %h2= User #{username}
+    - if FeatureSet(:user_profile_pic).visible?
+      = render :partial => '_profile_pic'
+
+    # config/initializers/features.rb
+
+    FeatureSet.define :user_profile_pic do |f|
+      f.show do
+        current_user? || (%w{test development}.include? Rails.env)
+      end
+
+      f.show 'users#show'
+      f.show 'users#destroy'
+      f.show 'users#create' do 
+        current_user?
+      end
+
+      f.hide 'users#index'
+      f.hide 'users#update'
+      f.hide 'users#create' do
+        if current_user?
+      end
+    end
+
+Jurisdiction Object:
+=============================
+
+    Sheriff::Jurisdiction.new *args                  # <= accept any arguments that CanCan will understand
+    Sheriff::Jurisdiction.new UsersController        # <= ability to execute any public method on UsersController
+    Sheriff::Jurisdiction.new 'UsersController#show' # <= ability to execute show on the UsersController
+    Sheriff::Jurisdiction.new 'users/show'           # <= ability to view route 'users/show'
+    Sheriff::Jurisdiction.new users_path             # <= ability to view users_path
+    Sheriff::Jurisdiction.new user_path(1)           # <= ability to view path for user with id=1
+

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/sheriff.rb

@@ -1,5 +1,6 @@
 require 'sheriff/api'
 require 'sheriff/context'
 require 'sheriff/feature_set'
+require 'sheriff/jurisdiction'
 require 'sheriff/errors'
 

data/lib/sheriff/api.rb

@@ -20,29 +20,17 @@ module Sheriff
     base.extend ClassMethods
   end
 
-  def self.define(feature_set_name)
-    raise Sheriff::FeatureSet::AlreadyDefinedError.new("Feature Set #{feature_set_name} already defined") if Sheriff.defined_feature_sets.map(&:name).include?(feature_set_name)
-    Sheriff.defined_feature_sets << Sheriff::FeatureSet.new(feature_set_name)
+  def FeatureSet(feature_set_name)
+    FeatureSet.find feature_set_name
   end
 
-  def self.find(name)
-    Sheriff.defined_feature_sets.select {|fs| fs.name == name}.first
-  end
-  
-  attr_accessor :visible
-  alias :visible? :visible
-
-  def feature_set
-    Sheriff.defined_feature_sets
-  end
+  def feature_set(feature_set_name)
+    context = self
 
-  def initialize
-    @visible = true
+    fs = FeatureSet.find(feature_set_name).dup
+    fs.context = context
+    fs
   end
 end
 
-if Module.const_defined? 'ActionController'
-  class ActionController::Base
-    include Sheriff
-  end
-end
+include Sheriff

data/lib/sheriff/feature_set.rb

@@ -3,10 +3,48 @@ module Sheriff
   class FeatureSet
 
     attr_reader :name
+    attr_accessor :context
+
     def initialize(name)
       @name = name
+      @jurisdiction = Sheriff::Jurisdiction.new()
+    end
+
+    def hide(*args)
+      @jurisdiction.hide *args
+    end
+
+    def show(*args)
+      @jurisdiction.show *args
+    end
+
+    def visible?
+      caller.first.match /`(.+)'$/
+      context_method = $1
+      @jurisdiction.can? context_method.to_sym, @context
     end
 
+    def self.define(feature_set_name)
+      if self.defined? feature_set_name
+        raise Sheriff::FeatureSet::AlreadyDefinedError.new("Feature Set #{feature_set_name} already defined")
+      end
+
+      new_feature_set = Sheriff::FeatureSet.new(feature_set_name)
+      Sheriff.defined_feature_sets << new_feature_set
+      yield(new_feature_set) if block_given?
+    end
+    
+    def self.defined?(feature_set_name)
+      Sheriff.defined_feature_sets.map(&:name).include?(feature_set_name)
+    end
+
+    def self.find(name)
+      Sheriff.defined_feature_sets.select {|fs| fs.name == name}.first
+    end
+
+    def self.all
+      Sheriff.defined_feature_sets
+    end
   end
 
 end

data/lib/sheriff/jurisdiction.rb

@@ -0,0 +1,16 @@
+require 'cancan'
+
+module Sheriff
+  class Jurisdiction
+    include CanCan::Ability
+
+    def show(method_name, const)
+      can method_name, const
+    end
+
+    def hide(method_name, const)
+      cannot method_name, const
+    end
+
+  end
+end

data/sheriff.gemspec

@@ -0,0 +1,82 @@
+# 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{sheriff}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anthony Navarre", "Jesse Trimble"]
+  s.date = %q{2011-02-13}
+  s.description = %q{Sheriff allows you to define "FeatureSets" and designate
+                       under which contexts the FeatureSet should be visible (eg: a specific view or controller)}
+  s.email = %q{me@anthonynavarre.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".pairs",
+    "CHANGELOG.txt",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "ROADMAP.md",
+    "Rakefile",
+    "VERSION",
+    "lib/sheriff.rb",
+    "lib/sheriff/api.rb",
+    "lib/sheriff/context.rb",
+    "lib/sheriff/errors.rb",
+    "lib/sheriff/feature_set.rb",
+    "lib/sheriff/jurisdiction.rb",
+    "sheriff.gemspec",
+    "test/helper.rb",
+    "test/sheriff/test_feature_set.rb"
+  ]
+  s.homepage = %q{http://github.com/anthonynavarre/sheriff}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Utility for hiding and showing features based on context}
+  s.test_files = [
+    "test/helper.rb",
+    "test/sheriff/test_feature_set.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<cancan>, ["= 1.5.1"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<redgreen>, ["= 1.2.2"])
+      s.add_development_dependency(%q<test-unit>, ["= 2.1.2"])
+    else
+      s.add_dependency(%q<cancan>, ["= 1.5.1"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<redgreen>, ["= 1.2.2"])
+      s.add_dependency(%q<test-unit>, ["= 2.1.2"])
+    end
+  else
+    s.add_dependency(%q<cancan>, ["= 1.5.1"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<redgreen>, ["= 1.2.2"])
+    s.add_dependency(%q<test-unit>, ["= 2.1.2"])
+  end
+end
+

data/test/sheriff/test_feature_set.rb

@@ -0,0 +1,75 @@
+require 'helper'
+
+class Sheriff::FeatureSetTest < Test::Unit::TestCase
+
+  context 'delicious bacon-wrapped context of chocolatey goodness' do
+
+    setup do
+      Sheriff.defined_feature_sets.clear
+    end
+
+    should 'have no defined features' do
+      deny FeatureSet.all.any?
+    end
+
+    should 'be able to define a feature' do
+      FeatureSet.define :share
+      assert FeatureSet.all.map(&:name).include? :share
+    end
+
+    context 'with a defined feature' do
+      setup do
+        FeatureSet.define :share
+      end
+
+      should 'know if a feature is already defined' do
+        assert FeatureSet.defined? :share
+      end
+
+      should 'know if a feature is *not* already defined' do
+        deny FeatureSet.defined? :undefined_feature
+      end
+
+      should 'raise when redefining the same feature' do
+        assert_raise Sheriff::FeatureSet::AlreadyDefinedError do
+          FeatureSet.define :share
+        end
+      end
+
+      should 'be able to find a feature' do
+        feature = FeatureSet(:share)
+        assert_equal :share, feature.name
+      end
+
+    end
+
+    context 'when executing within a context' do
+
+      setup do
+        class FakeContext
+          # include Sheriff::ContextInitializer
+
+          def show_method
+            feature_set(:fake_feature).visible?
+          end
+          def hide_method
+            feature_set(:fake_feature).visible?
+          end
+        end
+        FeatureSet.define :fake_feature do |f|
+          f.show :show_method, FakeContext
+          f.hide :hide_method, FakeContext
+        end
+      end
+
+      should 'be visible for FakeContext#show' do
+        assert FakeContext.new.show_method
+      end
+
+      should 'be hidden for FakeContext#hide' do
+        deny FakeContext.new.hide_method
+      end
+    end
+
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Anthony Navarre
@@ -15,12 +15,27 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-11 00:00:00 -07:00
+date: 2011-02-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: cancan
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -30,10 +45,10 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -45,10 +60,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -60,10 +75,10 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rcov
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -73,7 +88,37 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: redgreen
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 2
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :development
+  prerelease: false
+  version_requirements: *id007
 description: |-
   Sheriff allows you to define "FeatureSets" and designate
                          under which contexts the FeatureSet should be visible (eg: a specific view or controller)
@@ -87,12 +132,13 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- .pairs
 - CHANGELOG.txt
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.rdoc
-- ROADMAP.txt
+- ROADMAP.md
 - Rakefile
 - VERSION
 - lib/sheriff.rb
@@ -100,8 +146,10 @@ files:
 - lib/sheriff/context.rb
 - lib/sheriff/errors.rb
 - lib/sheriff/feature_set.rb
+- lib/sheriff/jurisdiction.rb
+- sheriff.gemspec
 - test/helper.rb
-- test/test_sheriff.rb
+- test/sheriff/test_feature_set.rb
 has_rdoc: true
 homepage: http://github.com/anthonynavarre/sheriff
 licenses: 
@@ -116,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3703422532125167574
+      hash: 2942043483335471323
       segments: 
       - 0
       version: "0"
@@ -137,4 +185,4 @@ specification_version: 3
 summary: Utility for hiding and showing features based on context
 test_files: 
 - test/helper.rb
-- test/test_sheriff.rb
+- test/sheriff/test_feature_set.rb

data/test/test_sheriff.rb

@@ -1,38 +0,0 @@
-require 'helper'
-
-class SheriffTest < Test::Unit::TestCase
-
-  context 'delicious bacon-wrapped context of chocolatey goodness' do
-
-    setup do 
-      Sheriff.defined_feature_sets.clear
-    end
-
-    should 'have no defined features' do
-      deny Sheriff.defined_feature_sets.any?
-    end
-
-    should 'be able to define a feature' do
-      Sheriff.define :share
-      assert Sheriff.defined_feature_sets.map(&:name).include? :share
-    end
-
-    context 'with a defined feature' do
-      setup do
-        Sheriff.define :share
-      end
-
-      should 'raise when redefining the same feature' do
-        assert_raise Sheriff::FeatureSet::AlreadyDefinedError do
-          Sheriff.define :share
-        end
-      end
-
-      should 'be able to find a feature set' do
-        assert Sheriff.find(:share), 
-      end
-    end
-  end
-
-end
-