switches 0.1.0 → 0.1.1

data/.gitignore

@@ -20,3 +20,4 @@ pkg
 
 ## PROJECT::SPECIFIC
 *.gem
+README.html

data/README

@@ -0,0 +1 @@
+Please see README.markdown or visit http://github.com/seamusabshere/switches

data/README.markdown

@@ -0,0 +1,145 @@
+# switches #
+
+Switches lets you turn on and off sections of your code with <tt>Switches.foobar?</tt> booleans.
+
+It's an extraction from [http://brighterplanet.com](http://brighterplanet.com), where we use it as an emergency button to turn on/off API integration with Facebook, Campaign Monitor, etc.
+
+## 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
+
+## Tasks ##
+
+<table>
+  <tr>
+    <th>Rake task</th>
+    <th>Cap task</th>
+    <th>Notes</th>
+  </tr>
+  <tr>
+    <td>rake s:c</td>
+    <td>cap TARGET s:c</td>
+    <td>show current switches</td>
+  </tr>
+  <tr>
+    <td>rake s:d</td>
+    <td>cap TARGET s:d</td>
+    <td>show difference between current and default switches</td>
+  </tr>
+  <tr>
+    <td>rake s:on[SWITCH]</td>
+    <td>cap TARGET s:on ARG=SWITCH</td>
+    <td>turn on SWITCH</td>
+  </tr>
+  <tr>
+    <td>rake s:off[SWITCH]</td>
+    <td>cap TARGET s:off ARG=SWITCH</td>
+    <td>turn off SWITCH</td>
+  </tr>
+  <tr>
+    <td>rake s:clear[SWITCH]</td>
+    <td>cap TARGET s:clear ARG=SWITCH</td>
+    <td>clear any switch for SWITCH</td>
+  </tr>
+  <tr>
+    <td>rake s:reset</td>
+    <td>cap TARGET s:reset</td>
+    <td>go back to defaults (deletes <tt>config/switches/current.yml</tt>)</td>
+  </tr>
+  <tr>
+    <td>rake s:backup</td>
+    <td>cap TARGET s:backup</td>
+    <td>backup current switches (copies to <tt>config/switches/backup.yml</tt>)</td>
+  </tr>
+  <tr>
+    <td>rake s:restore</td>
+    <td>cap TARGET s:restore</td>
+    <td>restore backed-up switches (copies <tt>backup.yml</tt> to <tt>current.yml</tt>)</td>
+  </tr>
+  <tr>
+    <td>rake s:default</td>
+    <td>cap TARGET s:default</td>
+    <td>list default settings</td>
+  </tr>
+</table>
+
+## Throwing switches remotely with Capistrano ##
+
+This is the minimum needed in the TARGET task:
+
+    task :production do
+      role :app, 'ec2-88-77-66-55.compute-1.amazonaws.com'
+      role :app, '177.133.33.144'
+  
+      set :rails_env, 'production'
+      set :deploy_to, '/data/my_app'
+      set :gfs, false
+    end
+
+The switches will get applied to any role that matches <tt>/app/</tt> (so :app_master, :app, etc.)
+
+## 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-1:/var/www/apps/my_app $ rake s:off[campaign_monitor]
+    production-server-1:/var/www/apps/my_app $ sudo monit restart all -g my_app
+    [...]
+    production-server-2:/var/www/apps/my_app $ rake s:off[campaign_monitor]
+    production-server-2:/var/www/apps/my_app $ sudo monit restart all -g my_app
+
+Or, even better, do it with cap:
+
+    my-macbook:~/my_app $ cap production s:off ARG=campaign_monitor
+    my-macbook:~/my_app $ cap production mongrel:restart
+
+For another example, 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 s: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.
+
+## Copyright ##
+
+Copyright (c) 2009 Seamus Abshere. See LICENSE for details.

data/VERSION

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

data/lib/switches.rb

@@ -6,14 +6,17 @@ require 'activesupport'
 
 module Switches
   CONFIG_DIR = File.join RAILS_ROOT, 'config', 'switches'
-  TASKS_DIR = File.join RAILS_ROOT, 'lib', 'tasks'
+  RAKE_PATH = File.join RAILS_ROOT, 'lib', 'tasks', 'switches.rake'
+  CAPISTRANO_PATH = File.join CONFIG_DIR, 'capistrano_tasks.rb'
+  CAPISTRANO_LOAD_PATH = CAPISTRANO_PATH.gsub "#{RAILS_ROOT}/", '' # => 'config/switches/capistrano_tasks.rb'
+  CAPFILE_PATH = File.join RAILS_ROOT, 'Capfile'
   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}"
+      $stderr.puts "[SWITCHES GEM] #{str.gsub "#{RAILS_ROOT}/", ''}"
     end
     
     def setup
@@ -29,12 +32,33 @@ module Switches
         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 "Refreshing gem-related Rake tasks at #{RAKE_PATH}."
+      FileUtils.cp File.join(File.dirname(__FILE__), 'tasks', 'switches.rake'), RAKE_PATH
+      
+      say "Refreshing gem-related Capistrano tasks at #{CAPISTRANO_PATH}."
+      FileUtils.cp File.join(File.dirname(__FILE__), 'tasks', 'capistrano_tasks.rb'), CAPISTRANO_PATH
+      
+      needs_append = false
+      if not File.exists?(CAPFILE_PATH)
+        say "Creating a Capfile and including our tasks in it."
+        needs_append = true
+        FileUtils.touch CAPFILE_PATH
+      elsif old_capfile = IO.read(CAPFILE_PATH) and old_capfile.include?(CAPISTRANO_LOAD_PATH)
+        say "Found a Capfile that already includes our tasks. Great!"
+      else
+        say "I'm going to add a line to your existing Capfile. Sorry if I break anything!"
+        needs_append = true
+      end
+      
+      File.open(CAPFILE_PATH, 'a') do |f|
+        say "Appending a line that loads our Capistrano tasks to your Capfile."
+        f.write "\n# Added by switches gem #{Time.now}\nload '#{CAPISTRANO_LOAD_PATH}'\n"
+      end if needs_append
       
       say "Don't forget to:"
       say "* git add #{DEFAULT_PATH}"
-      say "* git add #{TASKS_DIR}/switches.rake"
+      say "* git add #{RAKE_PATH}"
+      say "* git add #{CAPISTRANO_PATH}"
       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

data/lib/tasks/capistrano_tasks.rb

@@ -0,0 +1,71 @@
+# assumes you've got roles, deploy_to, rails_env
+
+require 'pp'
+require 'activesupport'
+require 'zlib'
+
+# basically { :a => 1, :b => 2 }.eql?({ :b => 2, :a => 1}) => true
+class StrictComparableHash < Hash
+  def eql?(other)
+    self == other
+  end
+
+  # must return an integer or #eql? will be ignored by Comparable
+  # assumes hash elements are strings
+  # will break if a value is something else whose to_s varies randomly
+  def hash
+    Zlib.crc32(to_a.map(&:to_s).sort.to_s)
+  end
+end
+
+# Hash.from_xml(a.gsub(/\n+/, ''))['hash']
+
+namespace :s do
+  %w{ c d on off clear reset backup restore default }.each do |cmd|
+    task cmd.to_sym, :roles => lambda { roles.keys.map(&:to_s).grep(/app/).map(&:to_sym) } do
+      
+      # download switches xml from servers
+      raw_input = Hash.new
+      run "cd #{deploy_to}/current; rake --silent s:#{cmd}#{"[#{ENV['ARG']}]" if ENV['ARG'].present?} RAILS_ENV=#{rails_env}; true" do |channel, stream, data|
+        server = channel[:server]
+        server_identifier = gfs ? server.host : "#{server.host}:#{server.port}".chomp(':')
+        raw_input[server_identifier] ||= Array.new
+        raw_input[server_identifier] << data
+      end
+      
+      grouped_by_server = raw_input.inject(Hash.new) do |memo, ary|
+        server_identifier, chunks = ary
+        server_hash = Hash.from_xml(chunks.join.gsub(/\n+/, ''))['hash']
+        memo[server_identifier] = server_hash.is_a?(Hash) ? StrictComparableHash[server_hash] : StrictComparableHash.new
+        memo
+      end
+      
+      first_server_switches = grouped_by_server.values.first
+
+      # If GFS, all server switches will be the same---just output them
+      if gfs
+        pp first_server_switches
+      else
+        grouped_by_switches = grouped_by_server.inject(Hash.new) do |memo, ary|
+          server_identifier, comparable_switches = ary
+          memo[comparable_switches] ||= Array.new
+          memo[comparable_switches] << server_identifier
+          memo
+        end
+        if grouped_by_switches.keys.length > 1
+          puts "Servers are different"
+          pp grouped_by_switches.invert
+          if grouped_by_switches.length == 2
+            a, b = grouped_by_switches.invert.values
+            puts
+            puts "Difference is"
+            pp a.diff(b)
+          end
+        else
+          puts "Servers are the same"
+          pp first_server_switches
+        end
+      end
+    end
+  end
+end

data/lib/tasks/switches.rake

@@ -1,88 +1,54 @@
 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
+  desc "List current"
+  task :c do
+    puts Switches.current.to_xml
   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
+  desc "Diff current vs. default switches"
+  task :d do
+    puts Switches.diff.to_xml
   end
-    
+
   desc "Turn on switch"
-  task :turn_on, :name do |t, args|
+  task :on, :name do |t, args|
     Switches.turn_on args.name
-    puts Switches.current.to_yaml
+    puts Switches.current.to_xml
   end
 
   desc "Turn off switch"
-  task :turn_off, :name do |t, args|
+  task :off, :name do |t, args|
     Switches.turn_off args.name
-    puts Switches.current.to_yaml
+    puts Switches.current.to_xml
   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
+    puts Switches.current.to_xml
   end
-  
+
   desc "Reset all switches to defaults"
   task :reset do
     Switches.reset
-    puts Switches.current.to_yaml
+    puts Switches.current.to_xml
   end
-  
+
   desc "Backup all switches to defaults"
   task :backup do
     Switches.backup
-    puts Switches.current.to_yaml
+    puts Switches.current.to_xml
   end
-  
+
   desc "Restore all switches to defaults"
   task :restore do
     Switches.restore
-    puts Switches.current.to_yaml
+    puts Switches.current.to_xml
+  end
+
+  desc "List default"
+  task :default do
+    puts Switches.default.to_xml
   end
 end

data/switches.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{switches}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   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.date = %q{2009-11-02}
   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.
 
@@ -37,16 +37,20 @@ It's inspired by ActiveSupport's StringInquirer (e.g. Rails.development?) and tr
   s.email = %q{seamus@abshere.net}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README",
+     "README.html",
+     "README.markdown"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README",
+     "README.markdown",
      "Rakefile",
      "VERSION",
      "lib/switches.rb",
+     "lib/tasks/capistrano_tasks.rb",
      "lib/tasks/switches.rake",
      "spec/spec.opts",
      "spec/spec_helper.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: switches
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Seamus Abshere
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-30 00:00:00 -04:00
+date: 2009-11-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,20 +55,25 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README
+- README.html
+- README.markdown
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README
+- README.markdown
 - Rakefile
 - VERSION
 - lib/switches.rb
+- lib/tasks/capistrano_tasks.rb
 - lib/tasks/switches.rake
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/switches_spec.rb
 - switches.gemspec
+- README.html
 has_rdoc: true
 homepage: http://github.com/seamusabshere/switches
 licenses: []

data/README.rdoc

@@ -1,81 +0,0 @@
-= 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.