state_pattern 1.2.0 → 1.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (93) hide show
  1. data/.gitignore +2 -0
  2. data/README.rdoc +188 -6
  3. data/Rakefile +0 -58
  4. data/examples/rails_2_3_8_button_example/README +243 -0
  5. data/examples/rails_2_3_8_button_example/Rakefile +10 -0
  6. data/examples/rails_2_3_8_button_example/app/controllers/application_controller.rb +2 -0
  7. data/examples/rails_2_3_8_button_example/app/controllers/buttons_controller.rb +18 -0
  8. data/examples/rails_2_3_8_button_example/app/helpers/application_helper.rb +3 -0
  9. data/examples/rails_2_3_8_button_example/app/models/button.rb +4 -0
  10. data/examples/rails_2_3_8_button_example/app/models/button/off.rb +7 -0
  11. data/examples/rails_2_3_8_button_example/app/models/button/on.rb +8 -0
  12. data/examples/rails_2_3_8_button_example/app/views/buttons/show.html.erb +9 -0
  13. data/examples/rails_2_3_8_button_example/app/views/layouts/application.html.erb +12 -0
  14. data/examples/rails_2_3_8_button_example/config/boot.rb +110 -0
  15. data/examples/rails_2_3_8_button_example/config/database.yml +22 -0
  16. data/examples/rails_2_3_8_button_example/config/environment.rb +41 -0
  17. data/examples/rails_2_3_8_button_example/config/environments/development.rb +17 -0
  18. data/examples/rails_2_3_8_button_example/config/environments/production.rb +28 -0
  19. data/examples/rails_2_3_8_button_example/config/environments/test.rb +28 -0
  20. data/examples/rails_2_3_8_button_example/config/initializers/backtrace_silencers.rb +7 -0
  21. data/examples/rails_2_3_8_button_example/config/initializers/cookie_verification_secret.rb +7 -0
  22. data/examples/rails_2_3_8_button_example/config/initializers/inflections.rb +10 -0
  23. data/examples/rails_2_3_8_button_example/config/initializers/mime_types.rb +5 -0
  24. data/examples/rails_2_3_8_button_example/config/initializers/new_rails_defaults.rb +21 -0
  25. data/examples/rails_2_3_8_button_example/config/initializers/session_store.rb +15 -0
  26. data/examples/rails_2_3_8_button_example/config/locales/en.yml +5 -0
  27. data/examples/rails_2_3_8_button_example/config/routes.rb +4 -0
  28. data/examples/rails_2_3_8_button_example/db/development.sqlite3 +0 -0
  29. data/examples/rails_2_3_8_button_example/db/migrate/20101009073737_create_buttons.rb +13 -0
  30. data/examples/rails_2_3_8_button_example/db/schema.rb +20 -0
  31. data/examples/rails_2_3_8_button_example/db/seeds.rb +7 -0
  32. data/examples/rails_2_3_8_button_example/db/test.sqlite3 +0 -0
  33. data/examples/rails_2_3_8_button_example/doc/README_FOR_APP +2 -0
  34. data/examples/rails_2_3_8_button_example/public/images/rails.png +0 -0
  35. data/examples/rails_2_3_8_button_example/public/javascripts/application.js +2 -0
  36. data/examples/rails_2_3_8_button_example/public/javascripts/controls.js +963 -0
  37. data/examples/rails_2_3_8_button_example/public/javascripts/dragdrop.js +973 -0
  38. data/examples/rails_2_3_8_button_example/public/javascripts/effects.js +1128 -0
  39. data/examples/rails_2_3_8_button_example/public/javascripts/prototype.js +4320 -0
  40. data/examples/rails_2_3_8_button_example/public/javascripts/rails.js +175 -0
  41. data/examples/rails_2_3_8_button_example/script/about +4 -0
  42. data/examples/rails_2_3_8_button_example/script/console +3 -0
  43. data/examples/rails_2_3_8_button_example/script/dbconsole +3 -0
  44. data/examples/rails_2_3_8_button_example/script/destroy +3 -0
  45. data/examples/rails_2_3_8_button_example/script/generate +3 -0
  46. data/examples/rails_2_3_8_button_example/script/performance/benchmarker +3 -0
  47. data/examples/rails_2_3_8_button_example/script/performance/profiler +3 -0
  48. data/examples/rails_2_3_8_button_example/script/plugin +3 -0
  49. data/examples/rails_2_3_8_button_example/script/runner +3 -0
  50. data/examples/rails_2_3_8_button_example/script/server +3 -0
  51. data/examples/rails_3_button_example/Gemfile +31 -0
  52. data/examples/rails_3_button_example/Gemfile.lock +75 -0
  53. data/examples/rails_3_button_example/Rakefile +7 -0
  54. data/examples/rails_3_button_example/app/controllers/application_controller.rb +3 -0
  55. data/examples/rails_3_button_example/app/controllers/buttons_controller.rb +13 -0
  56. data/examples/rails_3_button_example/app/models/button.rb +4 -0
  57. data/examples/rails_3_button_example/app/models/button/off.rb +7 -0
  58. data/examples/rails_3_button_example/app/models/button/on.rb +8 -0
  59. data/examples/rails_3_button_example/app/views/buttons/show.html.erb +9 -0
  60. data/examples/rails_3_button_example/app/views/layouts/application.html.erb +13 -0
  61. data/examples/rails_3_button_example/config.ru +4 -0
  62. data/examples/rails_3_button_example/config/application.rb +42 -0
  63. data/examples/rails_3_button_example/config/boot.rb +13 -0
  64. data/examples/rails_3_button_example/config/database.yml +22 -0
  65. data/examples/rails_3_button_example/config/environment.rb +5 -0
  66. data/examples/rails_3_button_example/config/environments/development.rb +26 -0
  67. data/examples/rails_3_button_example/config/initializers/backtrace_silencers.rb +7 -0
  68. data/examples/rails_3_button_example/config/initializers/inflections.rb +10 -0
  69. data/examples/rails_3_button_example/config/initializers/mime_types.rb +5 -0
  70. data/examples/rails_3_button_example/config/initializers/secret_token.rb +7 -0
  71. data/examples/rails_3_button_example/config/initializers/session_store.rb +8 -0
  72. data/examples/rails_3_button_example/config/locales/en.yml +5 -0
  73. data/examples/rails_3_button_example/config/routes.rb +5 -0
  74. data/examples/rails_3_button_example/db/development.sqlite3 +0 -0
  75. data/examples/rails_3_button_example/db/migrate/20101009052900_create_buttons.rb +13 -0
  76. data/examples/rails_3_button_example/db/schema.rb +21 -0
  77. data/examples/rails_3_button_example/db/test.sqlite3 +0 -0
  78. data/examples/rails_3_button_example/public/javascripts/application.js +2 -0
  79. data/examples/rails_3_button_example/public/javascripts/prototype.js +6001 -0
  80. data/examples/rails_3_button_example/public/javascripts/rails.js +175 -0
  81. data/examples/rails_3_button_example/public/stylesheets/scaffold.css +56 -0
  82. data/examples/rails_3_button_example/script/rails +6 -0
  83. data/examples/semaphore.rb +58 -0
  84. data/lib/state_pattern.rb +3 -1
  85. data/lib/state_pattern/active_record.rb +44 -0
  86. data/rails/init.rb +3 -0
  87. data/test/state_pattern/active_record/active_record_test.rb +71 -0
  88. data/test/state_pattern/active_record/schema.rb +7 -0
  89. data/test/state_pattern/active_record/test_helper.rb +25 -0
  90. data/test/test_helper.rb +1 -0
  91. metadata +204 -24
  92. data/VERSION +0 -1
  93. data/state_pattern.gemspec +0 -59
@@ -0,0 +1,10 @@
1
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
2
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
3
+
4
+ require(File.join(File.dirname(__FILE__), 'config', 'boot'))
5
+
6
+ require 'rake'
7
+ require 'rake/testtask'
8
+ require 'rake/rdoctask'
9
+
10
+ require 'tasks/rails'
@@ -0,0 +1,2 @@
1
+ class ApplicationController < ActionController::Base
2
+ end
@@ -0,0 +1,18 @@
1
+ class ButtonsController < ApplicationController
2
+ before_filter :load
3
+
4
+ def show
5
+ end
6
+
7
+ def push
8
+ flash[:notice] = @button.push!
9
+ redirect_to button_path
10
+ end
11
+
12
+ private
13
+
14
+ def load
15
+ @button = Button.first || Button.create!
16
+ end
17
+ end
18
+
@@ -0,0 +1,3 @@
1
+ # Methods added to this helper will be available to all templates in the application.
2
+ module ApplicationHelper
3
+ end
@@ -0,0 +1,4 @@
1
+ class Button < ActiveRecord::Base
2
+ include StatePattern::ActiveRecord
3
+ set_initial_state On
4
+ end
@@ -0,0 +1,7 @@
1
+ class Button::Off < StatePattern::State
2
+ def push!
3
+ transition_to(Button::On)
4
+ stateable.save!
5
+ "I am turned on :)"
6
+ end
7
+ end
@@ -0,0 +1,8 @@
1
+ class Button::On < StatePattern::State
2
+ def push!
3
+ transition_to(Button::Off)
4
+ stateable.save!
5
+ "I am turned off :("
6
+ end
7
+ end
8
+
@@ -0,0 +1,9 @@
1
+ <p id="notice"><%= notice %></p>
2
+
3
+ <p>
4
+ <b>State:</b>
5
+ <%= @button.state %>
6
+ </p>
7
+
8
+
9
+ <%= link_to 'Push', push_button_path, :method => :put %>
@@ -0,0 +1,12 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Button example</title>
5
+ <%= javascript_include_tag "prototype", "rails" %>
6
+ </head>
7
+ <body>
8
+
9
+ <%= yield %>
10
+
11
+ </body>
12
+ </html>
@@ -0,0 +1,110 @@
1
+ # Don't change this file!
2
+ # Configure your app in config/environment.rb and config/environments/*.rb
3
+
4
+ RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
5
+
6
+ module Rails
7
+ class << self
8
+ def boot!
9
+ unless booted?
10
+ preinitialize
11
+ pick_boot.run
12
+ end
13
+ end
14
+
15
+ def booted?
16
+ defined? Rails::Initializer
17
+ end
18
+
19
+ def pick_boot
20
+ (vendor_rails? ? VendorBoot : GemBoot).new
21
+ end
22
+
23
+ def vendor_rails?
24
+ File.exist?("#{RAILS_ROOT}/vendor/rails")
25
+ end
26
+
27
+ def preinitialize
28
+ load(preinitializer_path) if File.exist?(preinitializer_path)
29
+ end
30
+
31
+ def preinitializer_path
32
+ "#{RAILS_ROOT}/config/preinitializer.rb"
33
+ end
34
+ end
35
+
36
+ class Boot
37
+ def run
38
+ load_initializer
39
+ Rails::Initializer.run(:set_load_path)
40
+ end
41
+ end
42
+
43
+ class VendorBoot < Boot
44
+ def load_initializer
45
+ require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
46
+ Rails::Initializer.run(:install_gem_spec_stubs)
47
+ Rails::GemDependency.add_frozen_gem_path
48
+ end
49
+ end
50
+
51
+ class GemBoot < Boot
52
+ def load_initializer
53
+ self.class.load_rubygems
54
+ load_rails_gem
55
+ require 'initializer'
56
+ end
57
+
58
+ def load_rails_gem
59
+ if version = self.class.gem_version
60
+ gem 'rails', version
61
+ else
62
+ gem 'rails'
63
+ end
64
+ rescue Gem::LoadError => load_error
65
+ $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
66
+ exit 1
67
+ end
68
+
69
+ class << self
70
+ def rubygems_version
71
+ Gem::RubyGemsVersion rescue nil
72
+ end
73
+
74
+ def gem_version
75
+ if defined? RAILS_GEM_VERSION
76
+ RAILS_GEM_VERSION
77
+ elsif ENV.include?('RAILS_GEM_VERSION')
78
+ ENV['RAILS_GEM_VERSION']
79
+ else
80
+ parse_gem_version(read_environment_rb)
81
+ end
82
+ end
83
+
84
+ def load_rubygems
85
+ min_version = '1.3.2'
86
+ require 'rubygems'
87
+ unless rubygems_version >= min_version
88
+ $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
89
+ exit 1
90
+ end
91
+
92
+ rescue LoadError
93
+ $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
94
+ exit 1
95
+ end
96
+
97
+ def parse_gem_version(text)
98
+ $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
99
+ end
100
+
101
+ private
102
+ def read_environment_rb
103
+ File.read("#{RAILS_ROOT}/config/environment.rb")
104
+ end
105
+ end
106
+ end
107
+ end
108
+
109
+ # All that for this:
110
+ Rails.boot!
@@ -0,0 +1,22 @@
1
+ # SQLite version 3.x
2
+ # gem install sqlite3-ruby (not necessary on OS X Leopard)
3
+ development:
4
+ adapter: sqlite3
5
+ database: db/development.sqlite3
6
+ pool: 5
7
+ timeout: 5000
8
+
9
+ # Warning: The database defined as "test" will be erased and
10
+ # re-generated from your development database when you run "rake".
11
+ # Do not set this db to the same as development or production.
12
+ test:
13
+ adapter: sqlite3
14
+ database: db/test.sqlite3
15
+ pool: 5
16
+ timeout: 5000
17
+
18
+ production:
19
+ adapter: sqlite3
20
+ database: db/production.sqlite3
21
+ pool: 5
22
+ timeout: 5000
@@ -0,0 +1,41 @@
1
+ # Be sure to restart your server when you modify this file
2
+
3
+ # Specifies gem version of Rails to use when vendor/rails is not present
4
+ RAILS_GEM_VERSION = '2.3.8' unless defined? RAILS_GEM_VERSION
5
+
6
+ # Bootstrap the Rails environment, frameworks, and default configuration
7
+ require File.join(File.dirname(__FILE__), 'boot')
8
+
9
+ Rails::Initializer.run do |config|
10
+ # Settings in config/environments/* take precedence over those specified here.
11
+ # Application configuration should go into files in config/initializers
12
+ # -- all .rb files in that directory are automatically loaded.
13
+
14
+ # Add additional load paths for your own custom dirs
15
+ # config.load_paths += %W( #{RAILS_ROOT}/extras )
16
+
17
+ # Specify gems that this application depends on and have them installed with rake gems:install
18
+ config.gem "state_pattern"
19
+ # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
20
+ # config.gem "sqlite3-ruby", :lib => "sqlite3"
21
+ # config.gem "aws-s3", :lib => "aws/s3"
22
+
23
+ # Only load the plugins named here, in the order given (default is alphabetical).
24
+ # :all can be used as a placeholder for all plugins not explicitly named
25
+ # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
26
+
27
+ # Skip frameworks you're not going to use. To use Rails without a database,
28
+ # you must remove the Active Record framework.
29
+ # config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
30
+
31
+ # Activate observers that should always be running
32
+ # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
33
+
34
+ # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
35
+ # Run "rake -D time" for a list of tasks for finding time zone names.
36
+ config.time_zone = 'UTC'
37
+
38
+ # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
39
+ # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
40
+ # config.i18n.default_locale = :de
41
+ end
@@ -0,0 +1,17 @@
1
+ # Settings specified here will take precedence over those in config/environment.rb
2
+
3
+ # In the development environment your application's code is reloaded on
4
+ # every request. This slows down response time but is perfect for development
5
+ # since you don't have to restart the webserver when you make code changes.
6
+ config.cache_classes = false
7
+
8
+ # Log error messages when you accidentally call methods on nil.
9
+ config.whiny_nils = true
10
+
11
+ # Show full error reports and disable caching
12
+ config.action_controller.consider_all_requests_local = true
13
+ config.action_view.debug_rjs = true
14
+ config.action_controller.perform_caching = false
15
+
16
+ # Don't care if the mailer can't send
17
+ config.action_mailer.raise_delivery_errors = false
@@ -0,0 +1,28 @@
1
+ # Settings specified here will take precedence over those in config/environment.rb
2
+
3
+ # The production environment is meant for finished, "live" apps.
4
+ # Code is not reloaded between requests
5
+ config.cache_classes = true
6
+
7
+ # Full error reports are disabled and caching is turned on
8
+ config.action_controller.consider_all_requests_local = false
9
+ config.action_controller.perform_caching = true
10
+ config.action_view.cache_template_loading = true
11
+
12
+ # See everything in the log (default is :info)
13
+ # config.log_level = :debug
14
+
15
+ # Use a different logger for distributed setups
16
+ # config.logger = SyslogLogger.new
17
+
18
+ # Use a different cache store in production
19
+ # config.cache_store = :mem_cache_store
20
+
21
+ # Enable serving of images, stylesheets, and javascripts from an asset server
22
+ # config.action_controller.asset_host = "http://assets.example.com"
23
+
24
+ # Disable delivery errors, bad email addresses will be ignored
25
+ # config.action_mailer.raise_delivery_errors = false
26
+
27
+ # Enable threaded mode
28
+ # config.threadsafe!
@@ -0,0 +1,28 @@
1
+ # Settings specified here will take precedence over those in config/environment.rb
2
+
3
+ # The test environment is used exclusively to run your application's
4
+ # test suite. You never need to work with it otherwise. Remember that
5
+ # your test database is "scratch space" for the test suite and is wiped
6
+ # and recreated between test runs. Don't rely on the data there!
7
+ config.cache_classes = true
8
+
9
+ # Log error messages when you accidentally call methods on nil.
10
+ config.whiny_nils = true
11
+
12
+ # Show full error reports and disable caching
13
+ config.action_controller.consider_all_requests_local = true
14
+ config.action_controller.perform_caching = false
15
+ config.action_view.cache_template_loading = true
16
+
17
+ # Disable request forgery protection in test environment
18
+ config.action_controller.allow_forgery_protection = false
19
+
20
+ # Tell Action Mailer not to deliver emails to the real world.
21
+ # The :test delivery method accumulates sent emails in the
22
+ # ActionMailer::Base.deliveries array.
23
+ config.action_mailer.delivery_method = :test
24
+
25
+ # Use SQL instead of Active Record's schema dumper when creating the test database.
26
+ # This is necessary if your schema can't be completely dumped by the schema dumper,
27
+ # like if you have constraints or database-specific column types
28
+ # config.active_record.schema_format = :sql
@@ -0,0 +1,7 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
4
+ # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
5
+
6
+ # You can also remove all the silencers if you're trying do debug a problem that might steem from framework code.
7
+ # Rails.backtrace_cleaner.remove_silencers!
@@ -0,0 +1,7 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Your secret key for verifying the integrity of signed cookies.
4
+ # If you change this key, all old signed cookies will become invalid!
5
+ # Make sure the secret is at least 30 characters and all random,
6
+ # no regular words or you'll be exposed to dictionary attacks.
7
+ ActionController::Base.cookie_verifier_secret = 'c12e3766cb8d2ca37cb1d8520497fa102062078fe1ba363abf74fb7819dbd25da046c8c15563d24336f7b4d4622a6a3e5226881dcfc1f475e57e0d60c4912fe1';
@@ -0,0 +1,10 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new inflection rules using the following format
4
+ # (all these examples are active by default):
5
+ # ActiveSupport::Inflector.inflections do |inflect|
6
+ # inflect.plural /^(ox)$/i, '\1en'
7
+ # inflect.singular /^(ox)en/i, '\1'
8
+ # inflect.irregular 'person', 'people'
9
+ # inflect.uncountable %w( fish sheep )
10
+ # end
@@ -0,0 +1,5 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new mime types for use in respond_to blocks:
4
+ # Mime::Type.register "text/richtext", :rtf
5
+ # Mime::Type.register_alias "text/html", :iphone
@@ -0,0 +1,21 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # These settings change the behavior of Rails 2 apps and will be defaults
4
+ # for Rails 3. You can remove this initializer when Rails 3 is released.
5
+
6
+ if defined?(ActiveRecord)
7
+ # Include Active Record class name as root for JSON serialized output.
8
+ ActiveRecord::Base.include_root_in_json = true
9
+
10
+ # Store the full class name (including module namespace) in STI type column.
11
+ ActiveRecord::Base.store_full_sti_class = true
12
+ end
13
+
14
+ ActionController::Routing.generate_best_match = false
15
+
16
+ # Use ISO 8601 format for JSON serialized times and dates.
17
+ ActiveSupport.use_standard_json_time_format = true
18
+
19
+ # Don't escape HTML entities in JSON, leave that for the #json_escape helper.
20
+ # if you're including raw json in an HTML page.
21
+ ActiveSupport.escape_html_entities_in_json = false
@@ -0,0 +1,15 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Your secret key for verifying cookie session data integrity.
4
+ # If you change this key, all old sessions will become invalid!
5
+ # Make sure the secret is at least 30 characters and all random,
6
+ # no regular words or you'll be exposed to dictionary attacks.
7
+ ActionController::Base.session = {
8
+ :key => '_rails_2_3_8_button_example_session',
9
+ :secret => 'ad6183a3b2058c7aab51c1e7a8071ed29b60c83e91d72f890dd508f3d5374251e31a093cf29a7d40f987caa7f59a775a797b29f3ce514d2863df4924cb8f17c3'
10
+ }
11
+
12
+ # Use the database for sessions instead of the cookie-based default,
13
+ # which shouldn't be used to store highly confidential information
14
+ # (create the session table with "rake db:sessions:create")
15
+ # ActionController::Base.session_store = :active_record_store
@@ -0,0 +1,5 @@
1
+ # Sample localization file for English. Add more files in this directory for other locales.
2
+ # See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
3
+
4
+ en:
5
+ hello: "Hello world"
@@ -0,0 +1,4 @@
1
+ ActionController::Routing::Routes.draw do |map|
2
+ map.button '/', :controller => 'buttons', :action => 'show', :method => :get
3
+ map.push_button '/push', :controller => 'buttons', :action => 'push', :method => :put
4
+ end
@@ -0,0 +1,13 @@
1
+ class CreateButtons < ActiveRecord::Migration
2
+ def self.up
3
+ create_table :buttons do |t|
4
+ t.string :state
5
+
6
+ t.timestamps
7
+ end
8
+ end
9
+
10
+ def self.down
11
+ drop_table :buttons
12
+ end
13
+ end