simple_toggle 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 869a6ade85707be2b0d5fbb1b052e49719a5aadb
+  data.tar.gz: 05fd00d8dc8461fdf3aced5a720a07fde5d0da96
+SHA512:
+  metadata.gz: c094e6a24649714407402f8c68c3cd4e1f850d783296db4115f161dd672c15fa4c977b3b7dfe5d15add057ce7c91983aea48218fd2f104eca919fd97e0597725
+  data.tar.gz: a6407a408e287e8c8879d6b15cce78683caef239fc884e3bd46ada32f2e8711ef492cff767b9b01c292061344171d9a9940d6436dc04f3e2839b1c5a45ceaf67

data/.gitignore

@@ -0,0 +1,19 @@
+*.swp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+db.sqlite3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in feature_flag.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec -f d --no-profile' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Trevor Oke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 trevor-oke
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# FeatureFlag
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'feature_flag'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install feature_flag
+
+## Migration
+
+    $ rails generate feature_flag:install
+    $ rake db:migrate
+
+## Usage
+
+### Executing code based on feature
+
+    FeatureFlag::Toggle.when_active(:featurename) do
+      # feature code here
+    end
+
+### Testing if a feature is active
+
+    FeatureFlag::Toggle.active?(:featurename)
+
+### Ensuring a feature is active
+
+    FeatureFlag::Toggle.require(:featurename)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+

data/lib/generators/simple_toggle/install_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+
+module SimpleToggle
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "generates a migration for simpe toggles"
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def copy_migrations
+        copy_migration "create_simple_toggles.rb"
+      end
+
+      def self.next_migration_number(dirname)
+        Time.now.strftime("%Y%m%d%H%M%S")
+      end
+
+      protected
+      def copy_migration(migration_name)
+        if self.class.migration_exists?("db/migrate", migration_name)
+          say_status("skipped", "Migration #{migration_name} already exists")
+        else
+          migration_template "migrations/#{migration_name}", "db/migrate/#{migration_name}"
+        end
+      end
+    end
+  end
+end

data/lib/generators/templates/migrations/create_simple_toggles.rb

@@ -0,0 +1,15 @@
+class CreateSimpleToggleToggles < ActiveRecord::Migration
+  def change
+    create_table :simple_toggle_toggles do |t|
+      t.string :name
+      t.boolean :active
+
+      t.timestamps
+    end
+
+    add_index :simple_toggle_toggles, :name
+    add_index :simple_toggle_toggles, [:name, :active]
+  end
+end
+
+

data/lib/simple_toggle.rb

@@ -0,0 +1,22 @@
+require "rails"
+require "simple_toggle/version"
+require 'active_record'
+
+module SimpleToggle
+  class Toggle < ActiveRecord::Base
+    self.table_name = 'simple_toggle_toggles'
+
+    def self.when_active(feature)
+      yield if Toggle.active?(feature)
+    end
+
+    def self.require(feature)
+      raise unless Toggle.active?(feature)
+    end
+
+    def self.active?(feature)
+      toggle = Toggle.where(name: feature, active: true).first
+    end
+  end
+
+end

data/lib/simple_toggle/version.rb

@@ -0,0 +1,3 @@
+module SimpleToggle
+  VERSION = "1.0.1"
+end

data/simple_toggle.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_toggle/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "simple_toggle"
+  gem.version       = SimpleToggle::VERSION
+  gem.licenses      = ['MIT']
+  gem.authors       = ["Trevor Oke"]
+  gem.email         = ["trevor@trevoroke.com"]
+  gem.description   = %q{Simple feature toggle for ruby/rails}
+  gem.summary       = %q{A simple ActivceRecord based feature toggle for ruby/rails.}
+  gem.homepage      = "https://github.com/thefury/simple_toggle"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
+  gem.add_development_dependency 'sqlite3', '~> 1.0'
+
+  gem.add_runtime_dependency 'activerecord', '~> 4.2'
+  gem.add_runtime_dependency 'rails', '~> 4.0'
+end

data/spec/lib/simple_toggle_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe SimpleToggle::Toggle do
+  ACTIVE_PARAM = { name: "active", active: true }
+  INACTIVE_PARAM = { name: "inactive", active: false }
+
+  before(:each) do
+    SimpleToggle::Toggle.create!(ACTIVE_PARAM)
+    SimpleToggle::Toggle.create!(INACTIVE_PARAM)
+  end
+
+  describe ".active?" do
+    specify { expect(SimpleToggle::Toggle.active?(:unknown)).to be_falsey }
+    specify { expect(SimpleToggle::Toggle.active?(:active)).to be_truthy }
+    specify { expect(SimpleToggle::Toggle.active?(:inactive)).to be_falsey }
+  end
+
+  describe ".when_active" do
+    before(:each) do
+      @value = 0
+    end
+
+    it "does not execute the block for unknown toggles" do
+      SimpleToggle::Toggle.when_active(:unknown) { @value = 1 }
+      expect(@value).to eq 0
+    end
+
+    it "does not execute the block for inactive toggles" do
+      SimpleToggle::Toggle.when_active(:inactive) { @value = 1 }
+      expect(@value).to eq 0
+    end
+
+    it "executes the block for active toggles" do
+      SimpleToggle::Toggle.when_active(:active) { @value = 1 }
+      expect(@value).to eq 1
+    end
+  end
+
+  describe ".require" do
+    specify { expect{ SimpleToggle::Toggle.require(:unknown) }.to raise_exception }
+    specify { expect{ SimpleToggle::Toggle.require(:inactive) }.to raise_exception }
+    specify { expect{ SimpleToggle::Toggle.require(:active) }.to_not raise_exception }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'simple_toggle'
+require 'active_record'
+require 'sqlite3'
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: ':memory:')
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table 'simple_toggle_toggles', force: true do |t|
+    t.string :name
+    t.boolean :active
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: simple_toggle
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Trevor Oke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Simple feature toggle for ruby/rails
+email:
+- trevor@trevoroke.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/simple_toggle/install_generator.rb
+- lib/generators/templates/migrations/create_simple_toggles.rb
+- lib/simple_toggle.rb
+- lib/simple_toggle/version.rb
+- simple_toggle.gemspec
+- spec/lib/simple_toggle_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/thefury/simple_toggle
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: A simple ActivceRecord based feature toggle for ruby/rails.
+test_files:
+- spec/lib/simple_toggle_spec.rb
+- spec/spec_helper.rb
+has_rdoc: