switches 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Seamus Abshere
+
+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.rdoc

@@ -0,0 +1,81 @@
+= switches
+
+Switches lets you turn on and off sections of your code with <tt>Switches.foobar?</tt> booleans.
+
+== Quick start
+
+Add 2 lines to <tt>config/environment.rb</tt>:
+
+  require File.join(File.dirname(__FILE__), 'boot')
+  [...]
+  require 'switches'                                  # AFTER boot, BEFORE initializer
+  [...]
+  Rails::Initializer.run do |config|
+  [...]
+    config.gem 'switches', :lib => false              # INSIDE initializer
+
+Now run this:
+
+  my-macbook:~/my_app $ ./script/runner 'Switches.setup'
+
+Add your defaults to <tt>config/switches/defaults.yml</tt>:
+
+  --- 
+  ssl: true                   # ssl support is on by default
+  campaign_monitor: true      # campaign monitor integration is on by default
+
+== Rake tasks
+
+  rake s:c                    # show current switches
+  rake s:d                    # show difference between current and default switches
+  rake s:on[foobar]           # turn on "foobar"
+  rake s:off[foobar]          # turn off "foobar"
+
+  rake switches:clear[foobar] # clear any switch for "foobar" 
+  rake switches:reset         # go back to defaults
+  rake switches:backup        # backup current switches
+  rake switches:restore       # restore backed-up switches
+
+== Usage
+
+You can do stuff like (in <tt>app/models/user.rb</tt>):
+
+  after_create :subscribe_email if Switches.campaign_monitor?
+  def subscribe_email
+    CampaignMonitor.subscribe email
+  end
+
+Uhh ohh! Campaign Monitor's API is down and you need to shut off those failing after_creates, like, NOW.
+
+  production-server:/var/www/apps/my_app $ rake s:off[campaign_monitor]
+  production-server:/var/www/apps/my_app $ sudo monit restart all -g my_app
+
+Or let's say you're a developer who doesn't have a self-signed certificate:
+
+  my-macbook:~/my_app $ rake s:off[ssl]
+
+Those changes get persisted in <tt>config/switches/current.yml</tt>.
+
+If you want to see your switches vis-a-vis the defaults:
+
+  my-macbook:~/my_app $ rake s:d
+  --- 
+  ssl: true => false
+
+And if you want to go back to the defaults:
+
+  my-macbook:~/my_app $ rake switches:reset
+
+Remember, you should version control <tt>config/switches/defaults.yml</tt> and ignore <tt>config/switches/current.yml</tt>.
+
+== Rationale
+
+Sometimes you just need an easy way to "turn off" code.
+
+== Wishlist
+
+* capistrano task like "cap production s:off[campaign_monitor]"
+
+== Copyright
+
+Copyright (c) 2009 Seamus Abshere. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,72 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "switches"
+    gem.summary = %Q{Turn on and off parts of your code based on yaml files.}
+    gem.description = %Q{
+Switches lets you turn on and off parts of your code from the commandline. There's a defaults.yml and a current.yml in the background.
+
+For example:
+app/models/user.rb
+after_create :subscribe_email if Switches.campaign_monitor?
+
+>> Switches.campaign_monitor?
+# => false
+
+$ rake switches:on[campaign_monitor]
+
+>> Switches.campaign_monitor?
+# => true
+
+$ rake switches:reset # goes back to default.yml
+$ rake switches:diff  # shows diff b/w current.yml and default.yml
+$ rake s:d            # alias for switches:diff
+$ rake s:c            # alias for switches:list_current
+
+etc.
+
+It's inspired by ActiveSupport's StringInquirer (e.g. Rails.development?) and traditional compile-time assertions.
+    }
+    gem.email = "seamus@abshere.net"
+    gem.homepage = "http://github.com/seamusabshere/switches"
+    gem.authors = ["Seamus Abshere"]
+    gem.rubyforge_project = "switches"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "activesupport"
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "switches #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/switches.rb

@@ -0,0 +1,139 @@
+require 'yaml'
+require 'rubygems'
+require 'activesupport'
+
+# TODO not agnostic, expects RAILS_ROOT
+
+module Switches
+  CONFIG_DIR = File.join RAILS_ROOT, 'config', 'switches'
+  TASKS_DIR = File.join RAILS_ROOT, 'lib', 'tasks'
+  CURRENT_PATH = File.join CONFIG_DIR, 'current.yml'
+  DEFAULT_PATH = File.join CONFIG_DIR, 'default.yml'
+  BACKUP_PATH  = File.join CONFIG_DIR, 'backup.yml'
+  
+  class << self
+    def say(str)
+      $stderr.puts "[SWITCHES GEM] #{str}"
+    end
+    
+    def setup
+      require 'fileutils'
+      
+      say "Making #{CONFIG_DIR}."
+      FileUtils.mkdir_p CONFIG_DIR
+      
+      if File.exists? DEFAULT_PATH
+        say "Not putting an example default.yml into #{DEFAULT_PATH} because you already have one."
+      else
+        say "Putting an example default.yml into #{DEFAULT_PATH}."
+        File.open(DEFAULT_PATH, 'w') { |f| f.write({ 'quick_brown' => true, 'fox_jumps' => false }.to_yaml) }
+      end
+      
+      say "Copying Rake tasks into #{TASKS_DIR}."
+      FileUtils.cp File.join(File.dirname(__FILE__), 'tasks', 'switches.rake'), TASKS_DIR
+      
+      say "Don't forget to:"
+      say "* git add #{DEFAULT_PATH}"
+      say "* git add #{TASKS_DIR}/switches.rake"
+      say "* put 'config/switches/current.yml' to your .gitignore"
+      say "You can refresh the gem tasks with Switches.setup. It won't touch anything else."
+    end
+    
+    # taken from ActiveSupport::StringInquirer
+    def method_missing(method_name, *args)
+      suffix = method_name.to_s[-1,1]
+      key = method_name.to_s[0..-2]
+      
+      if suffix == "?" and current.has_key?(key)
+        current[key]
+      elsif suffix == "="
+        current[key] = args.first
+        # TEMPORARY since we're not doing a write_current here
+      else
+        super
+      end
+    end
+    
+    def default
+      return @_default unless @_default.nil?
+      # say "file system read #{DEFAULT_PATH}"
+      @_default = YAML.load(File.read(DEFAULT_PATH))
+      @_default.stringify_keys!
+    rescue Errno::ENOENT
+      say "Couldn't read defaults from #{DEFAULT_PATH}."
+      say "You probably want to run \"./script/runner 'Switches.setup'\"."
+      raise $!
+    end
+    
+    def current
+      return @_current unless @_current.nil?
+      if File.exist?(CURRENT_PATH)
+        # say "file system read #{CURRENT_PATH}"
+        @_current = YAML.load(File.read(CURRENT_PATH))
+        @_current.stringify_keys!
+      else
+        @_current = default.dup
+      end
+      @_current
+    end
+    
+    def diff
+      retval = {}
+      current.inject(retval) do |memo, ary|
+        k, current_v = ary
+        default_v = default[k]
+        memo[k] = "#{default_v.nil? ? 'nil' : default_v} => #{current_v.nil? ? 'nil' : current_v}" if default_v != current_v
+        memo
+      end
+      default.inject(retval) do |memo, ary|
+        k, default_v = ary
+        current_v = current[k]
+        memo[k] = "#{default_v.nil? ? 'nil' : default_v} => #{current_v.nil? ? 'nil' : current_v}" if default_v != current_v
+        memo
+      end
+      retval
+    end
+        
+    def turn_off(name)
+      name = name.to_s
+      current[name] = false
+      write_current
+    end
+    
+    def turn_on(name)
+      name = name.to_s
+      current[name] = true
+      write_current
+    end
+    
+    def clear(name)
+      name = name.to_s
+      current.delete name
+      write_current
+    end
+    
+    def reset
+      FileUtils.rm_f CURRENT_PATH
+      @_current = nil
+    end
+    
+    def backup
+      write_current
+      FileUtils.cp CURRENT_PATH, BACKUP_PATH
+    end
+    
+    def restore
+      if File.exist?(BACKUP_PATH)
+        FileUtils.mv BACKUP_PATH, CURRENT_PATH
+      else
+        raise ArgumentError, "#{BACKUP_PATH} doesn't exist."
+      end
+      @_current = nil
+    end
+    
+    def write_current
+      current # load it first!
+      File.open(CURRENT_PATH, 'w') { |f| f.write current.stringify_keys.to_yaml }
+    end
+  end
+end

data/lib/tasks/switches.rake

@@ -0,0 +1,88 @@
+require 'switches'
+
+task :switches do
+  Rake::Task['switches:default'].execute
+end
+
+namespace :s do
+  task :c => 'switches:list_current'
+  task :d => 'switches:diff'
+  task :on, :name do |t, args|
+    Rake::Task['switches:turn_on'].execute args
+  end
+  task :off, :name do |t, args|
+    Rake::Task['switches:turn_off'].execute args
+  end
+end
+
+namespace :switches do
+  desc "List current and show instructions"
+  task :default do
+    puts <<-EOS
+
+Here's a bunch of ugly instructions:
+
+List current settings:
+  rake s:c
+Show difference between current and default settings:
+  rake s:d
+Clear with:
+  rake switches:clear[FOOBAR]
+
+... now listing current settings ...
+    EOS
+    Rake::Task['switches:list_current'].execute
+  end
+  
+  # not called :default so it doesn't look like the default task
+  desc "List default"
+  task :list_default do
+    puts Switches.default.to_yaml
+  end
+  
+  desc "List current"
+  task :list_current do
+    puts Switches.current.to_yaml
+  end
+    
+  desc "Turn on switch"
+  task :turn_on, :name do |t, args|
+    Switches.turn_on args.name
+    puts Switches.current.to_yaml
+  end
+
+  desc "Turn off switch"
+  task :turn_off, :name do |t, args|
+    Switches.turn_off args.name
+    puts Switches.current.to_yaml
+  end
+  
+  desc "Clear switch"
+  task :clear, :name do |t, args|
+    Switches.clear args.name
+    puts Switches.current.to_yaml
+  end
+  
+  desc "Diff current vs. default switches"
+  task :diff do
+    puts Switches.diff.to_yaml
+  end
+  
+  desc "Reset all switches to defaults"
+  task :reset do
+    Switches.reset
+    puts Switches.current.to_yaml
+  end
+  
+  desc "Backup all switches to defaults"
+  task :backup do
+    Switches.backup
+    puts Switches.current.to_yaml
+  end
+  
+  desc "Restore all switches to defaults"
+  task :restore do
+    Switches.restore
+    puts Switches.current.to_yaml
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'switches'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/switches_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Switches" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/switches.gemspec

@@ -0,0 +1,83 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{switches}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Seamus Abshere"]
+  s.date = %q{2009-10-30}
+  s.description = %q{
+Switches lets you turn on and off parts of your code from the commandline. There's a defaults.yml and a current.yml in the background.
+
+For example:
+app/models/user.rb
+after_create :subscribe_email if Switches.campaign_monitor?
+
+>> Switches.campaign_monitor?
+# => false
+
+$ rake switches:on[campaign_monitor]
+
+>> Switches.campaign_monitor?
+# => true
+
+$ rake switches:reset # goes back to default.yml
+$ rake switches:diff  # shows diff b/w current.yml and default.yml
+$ rake s:d            # alias for switches:diff
+$ rake s:c            # alias for switches:list_current
+
+etc.
+
+It's inspired by ActiveSupport's StringInquirer (e.g. Rails.development?) and traditional compile-time assertions.
+    }
+  s.email = %q{seamus@abshere.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/switches.rb",
+     "lib/tasks/switches.rake",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/switches_spec.rb",
+     "switches.gemspec"
+  ]
+  s.homepage = %q{http://github.com/seamusabshere/switches}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{switches}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Turn on and off parts of your code based on yaml files.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/switches_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: switches
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Seamus Abshere
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-30 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "\n\
+  Switches lets you turn on and off parts of your code from the commandline. There's a defaults.yml and a current.yml in the background.\n\n\
+  For example:\n\
+  app/models/user.rb\n\
+  after_create :subscribe_email if Switches.campaign_monitor?\n\n\
+  >> Switches.campaign_monitor?\n\
+  # => false\n\n\
+  $ rake switches:on[campaign_monitor]\n\n\
+  >> Switches.campaign_monitor?\n\
+  # => true\n\n\
+  $ rake switches:reset # goes back to default.yml\n\
+  $ rake switches:diff  # shows diff b/w current.yml and default.yml\n\
+  $ rake s:d            # alias for switches:diff\n\
+  $ rake s:c            # alias for switches:list_current\n\n\
+  etc.\n\n\
+  It's inspired by ActiveSupport's StringInquirer (e.g. Rails.development?) and traditional compile-time assertions.\n    "
+email: seamus@abshere.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/switches.rb
+- lib/tasks/switches.rake
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/switches_spec.rb
+- switches.gemspec
+has_rdoc: true
+homepage: http://github.com/seamusabshere/switches
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: switches
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Turn on and off parts of your code based on yaml files.
+test_files: 
+- spec/spec_helper.rb
+- spec/switches_spec.rb