feature_definitions 0.2.0 → 0.3.0

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

@@ -2,13 +2,16 @@ source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
 #   gem "activesupport", ">= 2.3.5"
-gem 'lazy_const'
+gem 'lazy_const', '~> 0.1.3'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "minitest", ">= 0"
-  gem "rdoc", "~> 3.12"
   gem "bundler"
-  gem "jeweler", "~> 1.8.4"
+  gem 'rake'
+  unless ENV['TRAVIS']
+    gem "rdoc", "~> 3.12"
+    gem "jeweler", "~> 1.8.4"
+  end
 end

data/README.rdoc

@@ -1,25 +1,55 @@
 = feature_definitions
 
+{<img src="https://travis-ci.org/rmg/feature_definitions.png?branch=master" alt="Build Status" />}[https://travis-ci.org/rmg/feature_definitions]
+
 A minimal useful feature toggle mechanism.
 
+Thanks to Travis-CI, tested on:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+
 == Installation
 
   gem 'feature_definitions'
 
 == Example
 
+=== Using constructor
+lib/features.rb:
+  class Features < FeatureDefinitions
+    AWESOME = self.new {|flags| flags.is_awesome? }
+  end
+
+app/main.rb:
+  Features.context = args_to_flags
+
+app/elsewhere.rb
+  def some_method
+    Features.AWESOME.enabled? do
+      # do feature
+    end
+    # else noop
+  end
+
+=== Rails (and define_feature helper)
 Rails is *NOT* required, but this is how you would use this gem with Rails.
 
 app/model/features.rb:
   class Features < FeatureDefinitions
-    define_feature :AWESOME, using: [:current_user] do |user|
+    define_feature :AWESOME do |user|
       user.is_awesome?
     end
   end
 
 app/controller/application_controller.rb:
   class ApplicationController < ActionController::Base
-    before_filter { |controller| Features.context = controller }
+    before_filter { |controller| Features.context = controller.current_user }
   end
 
 app/views/some/view.erb.html:

data/Rakefile

@@ -11,19 +11,31 @@ rescue Bundler::BundlerError => e
 end
 require 'rake'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "feature_definitions"
-  gem.homepage = "http://github.com/rmg/feature_definitions"
-  gem.license = "MIT"
-  gem.summary = %Q{Simple and flexible feature definition}
-  gem.description = %Q{Simple and flexible feature toggle defintion}
-  gem.email = "r.m.graham@gmail.com"
-  gem.authors = ["Ryan Graham"]
-  # dependencies defined in Gemfile
+unless ENV['TRAVIS']
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+    gem.name = "feature_definitions"
+    gem.homepage = "http://github.com/rmg/feature_definitions"
+    gem.license = "MIT"
+    gem.summary = %Q{Simple and flexible feature definition}
+    gem.description = %Q{Simple and flexible feature toggle defintion}
+    gem.email = "r.m.graham@gmail.com"
+    gem.authors = ["Ryan Graham"]
+    # dependencies defined in Gemfile
+  end
+  Jeweler::RubygemsDotOrgTasks.new
+
+  require 'rdoc/task'
+  Rake::RDocTask.new do |rdoc|
+    version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "feature_definitions #{version}"
+    rdoc.rdoc_files.include('README*')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
 end
-Jeweler::RubygemsDotOrgTasks.new
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -34,12 +46,3 @@ end
 
 task :default => :test
 
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "feature_definitions #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/feature_definitions.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "feature_definitions"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Graham"]
@@ -18,12 +18,14 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
     "README.rdoc",
     "Rakefile",
     "VERSION",
     "feature_definitions.gemspec",
+    "lazy_const.gemspec",
     "lib/feature_definitions.rb",
     "test/helper.rb",
     "test/test_feature_definitions.rb"
@@ -38,23 +40,26 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<lazy_const>, [">= 0"])
+      s.add_runtime_dependency(%q<lazy_const>, ["~> 0.1.3"])
       s.add_development_dependency(%q<minitest>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
     else
-      s.add_dependency(%q<lazy_const>, [">= 0"])
+      s.add_dependency(%q<lazy_const>, ["~> 0.1.3"])
       s.add_dependency(%q<minitest>, [">= 0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     end
   else
-    s.add_dependency(%q<lazy_const>, [">= 0"])
+    s.add_dependency(%q<lazy_const>, ["~> 0.1.3"])
     s.add_dependency(%q<minitest>, [">= 0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
   end
 end

data/lazy_const.gemspec

@@ -0,0 +1,66 @@
+# 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 = "lazy_const"
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Graham"]
+  s.date = "2013-03-19"
+  s.description = "Allows you to define lazy evaluated, constant-like instances of your class."
+  s.email = "r.m.graham@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".travis.yml",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "feature_definitions.gemspec",
+    "lazy_const.gemspec",
+    "lib/feature_definitions.rb",
+    "test/helper.rb",
+    "test/test_feature_definitions.rb"
+  ]
+  s.homepage = "http://github.com/rmg/lazy_const"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "A little Ruby gem for defining lazy evaluated constants."
+
+  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<lazy_const>, ["~> 0.1.3"])
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<lazy_const>, ["~> 0.1.3"])
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<lazy_const>, ["~> 0.1.3"])
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/lib/feature_definitions.rb

@@ -2,17 +2,24 @@ require 'lazy_const'
 
 class FeatureDefinitions
   extend LazyConst
-  attr_reader :opts, :test_proc
+  attr_reader :test_proc
 
-  def self.define_feature(name, opts = {}, &block)
-    lazy_const(name){ new(opts, block.to_proc) }
+  def self.define_feature(name, &block)
+    lazy_const(name) { new(&block) }
   end
 
-  def initialize(opts, proc)
-    @opts = opts
-    @test_proc = proc
+  PASSTHROUGH = Proc.new { |arg| arg }
+
+  def initialize(&block)
+    if block_given?
+      @test_proc = block.to_proc
+    else
+      @test_proc = PASSTHROUGH
+    end
   end
 
+  @@context = nil
+
   def self.context=(context)
     @@context = context
   end
@@ -22,9 +29,8 @@ class FeatureDefinitions
   end
 
   def enabled?(&block)
-    args = opts[:using].map { |sym| context.public_send(sym) }
-    test_proc.call(*args).tap do |verdict|
-      yield if block_given? and verdict
+    test_proc.call(context).tap do |verdict|
+      yield if verdict and block_given?
     end
   end
 end

data/test/test_feature_definitions.rb

@@ -1,30 +1,87 @@
 require 'helper'
 
-class Features < FeatureDefinitions
-  define_feature :AWESOME, using: [:is_awesome?] do |awesome|
-    awesome
-  end
+class ConstFeatures < FeatureDefinitions
+  ALWAYS_ENABLED_FEATURE = self.new { |context| true }
+  ALWAYS_DISABLED_FEATURE = self.new { |context| false }
 end
 
 class TestFeatureDefinitions < MiniTest::Unit::TestCase
+  def test_feature_definition_helper
+    feature_class = Class.new(FeatureDefinitions) do
+      define_feature :FEATURE_NAME do |context|
+        true
+      end
+    end
+    assert feature_class.respond_to? :FEATURE_NAME
+    assert feature_class.FEATURE_NAME.enabled?
+  end
+  def test_feature_definition_constructor
+    feature_class = Class.new(FeatureDefinitions)
+    feature = feature_class.new { |context| true }
+    assert feature.enabled?
+  end
+  def test_constant_feature_definitions
+    assert ConstFeatures::ALWAYS_ENABLED_FEATURE.enabled?
+    refute ConstFeatures::ALWAYS_DISABLED_FEATURE.enabled?
+  end
+end
+
+class TestFeatureDefinitionsUsage < MiniTest::Unit::TestCase
+  def setup
+    @feature_class = Class.new(FeatureDefinitions) do
+      define_feature :AWESOME do |context|
+        context.is_awesome?
+      end
+    end
+  end
+  def test_feature_enabled
+    @feature_class.context = OpenStruct.new(:is_awesome? => true)
+    assert @feature_class.AWESOME.enabled?
+  end
+  def test_feature_disabled
+    @feature_class.context = OpenStruct.new(:is_awesome? => false)
+    refute @feature_class.AWESOME.enabled?
+  end
+  def test_feature_toggle
+    @feature_class.context = OpenStruct.new(:is_awesome? => true)
+    assert @feature_class.AWESOME.enabled?
+    @feature_class.context = OpenStruct.new(:is_awesome? => false)
+    refute @feature_class.AWESOME.enabled?
+  end
+  def test_feature_toggle_with_block
+    @feature_class.context = OpenStruct.new(:is_awesome? => true)
+    called = false
+    @feature_class.AWESOME.enabled? do
+      called = true
+    end
+    assert called
+  end
+end
+
+class TestFeatureDefaultBlock < MiniTest::Unit::TestCase
+  def setup
+    @feature_class = Class.new(FeatureDefinitions) do
+      define_feature :AWESOME
+    end
+  end
   def test_feature_enabled
-    Features.context = OpenStruct.new(is_awesome?: true)
-    assert Features.AWESOME.enabled?
+    @feature_class.context = true
+    assert @feature_class.AWESOME.enabled?
   end
   def test_feature_disabled
-    Features.context = OpenStruct.new(is_awesome?: false)
-    refute Features.AWESOME.enabled?
+    @feature_class.context = false
+    refute @feature_class.AWESOME.enabled?
   end
   def test_feature_toggle
-    Features.context = OpenStruct.new(is_awesome?: true)
-    assert Features.AWESOME.enabled?
-    Features.context = OpenStruct.new(is_awesome?: false)
-    refute Features.AWESOME.enabled?
+    @feature_class.context = true
+    assert @feature_class.AWESOME.enabled?
+    @feature_class.context = false
+    refute @feature_class.AWESOME.enabled?
   end
   def test_feature_toggle_with_block
-    Features.context = OpenStruct.new(is_awesome?: true)
+    @feature_class.context = true
     called = false
-    Features.AWESOME.enabled? do
+    @feature_class.AWESOME.enabled? do
       called = true
     end
     assert called

metadata

@@ -2,7 +2,7 @@
 name: feature_definitions
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ryan Graham
@@ -15,17 +15,17 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.3
   type: :runtime
   name: lazy_const
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.3
   prerelease: false
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,17 +47,17 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
   type: :development
-  name: rdoc
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
   prerelease: false
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -75,6 +75,22 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  prerelease: false
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -100,12 +116,14 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - .document
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
 - feature_definitions.gemspec
+- lazy_const.gemspec
 - lib/feature_definitions.rb
 - test/helper.rb
 - test/test_feature_definitions.rb
@@ -123,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: -3803903361324450403
+      hash: -4330562717910034088
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false