blue_print 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dac49db02726e3eb81813a54cc21dcb925c0fdc7
-  data.tar.gz: 94fa55109ad2e66a624696f8c71b6c135e95cc79
+  metadata.gz: 206433cbd4ea20e4889db2b3925b82d6f133bd21
+  data.tar.gz: 37a77da96f4fd80e0646e084cc640c93530dbd60
 SHA512:
-  metadata.gz: e70beb4dc39b6ac98e9e4c8400e7c531b116b3a66bae91d7d6514a3c4a75cb66eabf46ff0c6d4dcdbce2a066caad103c8c5aa5a28ed2a8e827533b9514f453ee
-  data.tar.gz: 15922fb424ff0b7dd63e423b6677fca54e565c734f179a975864a33a53dd4588d6af9597274a5fb134f329ae8e31a7861916f5c3561da9cc4746302ff90d34c2
+  metadata.gz: 2a94144f0ef54288803e77e932a9dc42e4bbcf621af214a4cb3a7d52c8108119758efe47107603d656a56e3d8ce65d6977ec4e5273b1ffa86e9d420859aacc89
+  data.tar.gz: 4aa19df93eb03d52a7ad5f17a214310339ac9f74fa0da8d65e30a2fe4bb9fce1e2857285fb37468b8dda7bc84576800c232a367ffa8ee87be2aefcf9d87d3dec

data/README.md

@@ -1,23 +1,170 @@
 # BluePrint
 
-[![Build Status](https://travis-ci.org/magnet-inc/blue_print.png?branch=master)](https://travis-ci.org/magnet-inc/blue_print) [![Coverage Status](https://coveralls.io/repos/magnet-inc/blue_print/badge.png)](https://coveralls.io/r/magnet-inc/blue_print) [![Code Climate](https://codeclimate.com/github/magnet-inc/blue_print.png)](https://codeclimate.com/github/magnet-inc/blue_print)
+[![Gem Version](https://badge.fury.io/rb/blue_print.png)](http://badge.fury.io/rb/blue_print)
+[![Build Status](https://travis-ci.org/magnet-inc/blue_print.png?branch=master)](https://travis-ci.org/magnet-inc/blue_print)
+[![Coverage Status](https://coveralls.io/repos/magnet-inc/blue_print/badge.png)](https://coveralls.io/r/magnet-inc/blue_print)
+[![Code Climate](https://codeclimate.com/github/magnet-inc/blue_print.png)](https://codeclimate.com/github/magnet-inc/blue_print)
 
-The behavior switching framework for Rails
+The behavior switching framework. inspired by [DCI](http://en.wikipedia.org/wiki/Data,_context_and_interaction).
 
 ## Requirements
 
 - __Ruby__ >= _2.0.0_
-- __Rails__ >= _3.1.0_
+  - Tested ruby version:
+    - 2.0.0
+    - 2.1.0
+    - 2.1.1
+    - head
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'blue_print', '~> 0.0.1'
+```ruby
+gem 'blue_print', '~> 1.2.0'
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Integration
+
+BluePrint provides some integrations. Now supported libraries:
+
+- [Ruby on Rails](http://rubyonrails.org/) >= 3.1
+- [Grape](http://intridea.github.io/grape/)
+- [Draper](https://github.com/drapergem/draper)
+- [RSpec](https://github.com/rspec)
+
+### Rails Generators
+
+BluePrint provides a generator to create templates of a context and behaviros.
+
+```bash
+$ rails generate blue_print staff user:staff_user
+     create  app/blue_prints/staff_context.rb
+     create  app/blue_prints/staff_context/staff_user.rb
+     invoke  rspec
+     create    spec/blue_prints/staff_context_spec.rb
+     create    spec/blue_prints/staff_context/staff_user_spec.rb
+```
+
+### Contexts
+
+Contexts inherit from `BluePrint::Context`, live in your `app/blue_prints` directory.
+
+#### active_if
+
+This block is used to decide if this context active or not. `env` is the `BluePrint.env`. `self` is passed via `BluePrint::Environment#context`. By default, this is set as `active_if { false }`.
+
+```ruby
+class StaffContext < BluePrint::Context
+  active_if do |env|
+    current_user.try(:staff?)
+  end
+end
+```
+
+And you can define named active if:
+
+```ruby
+# lib/active_ifs/staff.rb
+BluePrint::ActiveIf.new(:staff) do |env|
+  current_user.try(:staff?)
+end
+
+# app/blue_prints/staff_context.rb
+class StaffContext < BluePrint::Context
+  active_if :staff
+end
+```
+
+#### Casting
+
+Contexts has casting. This is used to decide classes cast as behaviors if this context active.
+
+```ruby
+class StaffContext < BluePrint::Context
+  cast ::User, as: [StaffUser]
+end
+
+StaffContext.casting
+# =>
+#   {
+#     User => [ StaffUser ]
+#   }
+```
+
+### Behaviors
+
+Behaviors extended by `BluePrint::Behavior`, live in your `app/blue_prints/{context}` directory.
+
+```ruby
+# app/blue_prints/staff_context/staff_user.rb
+module StaffContext::StaffUser
+  extend BluePrint::Behavior
+end
+```
+
+#### Methods
+
+Behaviors can have some methods.
+
+```ruby
+# app/blue_prints/staff_context/staff_user.rb
+module StaffContext::StaffUser
+  extend BluePrint::Behavior
+
+  def user_name
+    "staff"
+  end
+end
+
+# app/models/user.rb
+class User < ActiveRecord::Base
+  def user_name
+    "#{name} san"
+  end
+end
+
+user = User.new(name: "Magnet")
+user.user_name # => "Magnet san"
+within_context_of(StaffContext) do
+  user.user_name # => "staff"
+end
+```
+
+#### Class Methods
+
+Behaviors can have some class methods.
+
+```ruby
+# app/blue_prints/staff_context/staff_user.rb
+module StaffContext::StaffUser
+  extend BluePrint::Behavior
+
+  module ClassMethods
+    def find(id)
+      where(id: id, staff: true).first!
+    end
+  end
+end
+
+# app/models/user.rb
+class User < ActiveRecord::Base
+end
+
+user = User.create(staff: false)
+User.find(user.id) == user # => true
+within_context_of(StaffContext) do
+  User.find(user.id) # => raise ActiveRecord::NotFound
+end
+```
+
+### Helper
+
+`BluePrint::Helper` provides `#within_context_of` method.
+
+This module includes automatically to some classes. see [lib/blue_print/integration](https://github.com/magnet-inc/blue_print/tree/master/lib/blue_print/integration).
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,47 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
+desc 'Take benchmark'
+task :benchmark do
+  require File.expand_path('../benchmark/pure', __FILE__)
+  require File.expand_path('../benchmark/with_blue_print', __FILE__)
+  require File.expand_path('../benchmark/with_extend', __FILE__)
+
+  result = {
+    ruby: {
+      version: RUBY_VERSION,
+      platform: RUBY_PLATFORM
+    },
+    benchmark_iteration: BENCHMARK_ITERATION,
+    method_call_iteration: NUM_ITERATION,
+    benchmarks: {
+      pure: PURE_RESULT,
+      blue_print: BLUE_PRINT_RESULT,
+      extend: EXTEND_RESULT
+    }
+  }
+
+  result[:benchmarks].each_pair do |label, scores|
+    puts "#{label}:"
+    totals = scores.map(&:total)
+    avg = totals.inject(&:+).to_f / totals.size
+    puts "  min: #{totals.min.round(3)} max: #{totals.max.round(3)} avg: #{avg.round(3)}"
+  end
+end
+
+namespace :profile do
+  PROFILES = Dir['profile/*.rb'].map {|f| File.basename(f, '.rb') }
+
+  PROFILES.each do |profile|
+    desc "take #{profile} profile"
+    task profile do
+      require File.expand_path("../profile/#{profile}", __FILE__)
+    end
+  end
+
+  desc 'take all profiles'
+  task :all do
+    PROFILES.each do |profile|
+      Rake::Task["profile:#{profile}"].invoke
+    end
+  end
+end

data/benchmark/pure.rb

@@ -0,0 +1,68 @@
+require 'active_support/core_ext/integer/inflections'
+require 'ruby-progressbar'
+require 'benchmark'
+
+LABEL_WIDTH = 10
+BENCHMARK_ITERATION = 100
+NUM_ITERATION = 100000
+
+class Model
+  def self.active?
+    @active
+  end
+
+  def self.activate!
+    @active = true
+  end
+
+  def self.deactivate!
+    @active = false
+  end
+
+  def name
+    if self.class.active?
+      :pure
+    else
+      :pure
+    end
+  end
+end
+
+class NoEffect
+  def name
+    :no_effect
+  end
+end
+
+model = Model.new
+
+PURE_RESULT = []
+progress = ProgressBar.create(
+  title: model.name.to_s.ljust(LABEL_WIDTH),
+  total: BENCHMARK_ITERATION
+)
+GC.start
+BENCHMARK_ITERATION.times do |n|
+  n += 1
+
+  PURE_RESULT.push(
+    Benchmark.measure("#{n}#{n.ordinal}") do
+      Model.activate!
+
+      NUM_ITERATION.times do
+        Model.new.name
+        NoEffect.new.name
+      end
+
+      Model.deactivate!
+
+      NUM_ITERATION.times do
+        Model.new.name
+        NoEffect.new.name
+      end
+    end
+  )
+
+  progress.increment
+end
+progress.finish

data/benchmark/with_blue_print.rb

@@ -0,0 +1,57 @@
+require 'blue_print'
+require File.expand_path('../pure', __FILE__)
+
+BluePrint.env = BluePrint::Environment.new(nil)
+
+class Model
+  def name
+    :pure
+  end
+end
+
+class BenchmarkContext < BluePrint::Context
+  activate!
+
+  module BenchmarkModel
+    extend BluePrint::Behavior
+
+    def name
+      :blue_print
+    end
+  end
+
+  cast Model, as: [BenchmarkModel]
+end
+
+model = Model.new
+
+BLUE_PRINT_RESULT = []
+progress = ProgressBar.create(
+  title: model.name.to_s.ljust(LABEL_WIDTH),
+  total: BENCHMARK_ITERATION
+)
+GC.start
+BENCHMARK_ITERATION.times do |n|
+  n += 1
+
+  BLUE_PRINT_RESULT.push(
+    Benchmark.measure("#{n}#{n.ordinal}") do
+      BenchmarkContext.activate!
+
+      NUM_ITERATION.times do
+        Model.new.name
+        NoEffect.new.name
+      end
+
+      BenchmarkContext.deactivate!
+
+      NUM_ITERATION.times do
+        Model.new.name
+        NoEffect.new.name
+      end
+    end
+  )
+
+  progress.increment
+end
+progress.finish

data/benchmark/with_extend.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../pure', __FILE__)
+
+class Model
+  def name
+    :pure
+  end
+end
+
+module ExtendedUser
+  def name
+    :extended
+  end
+end
+
+model = Model.new.extend(ExtendedUser)
+
+EXTEND_RESULT = []
+progress = ProgressBar.create(
+  title: model.name.to_s.ljust(LABEL_WIDTH),
+  total: BENCHMARK_ITERATION
+)
+GC.start
+BENCHMARK_ITERATION.times do |n|
+  n += 1
+
+  EXTEND_RESULT.push(
+    Benchmark.measure("#{n}#{n.ordinal}") do
+      NUM_ITERATION.times do
+        Model.new.extend(ExtendedUser).name
+        NoEffect.new.name
+      end
+
+      NUM_ITERATION.times do
+        Model.new.name
+        NoEffect.new.name
+      end
+    end
+  )
+
+  progress.increment
+end
+progress.finish

data/blue_print.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = BluePrint::VERSION
   spec.authors       = ['Sho Kusano']
   spec.email         = ['rosylilly@aduca.org']
-  spec.summary       = %q{The behavior switching framework for Rails}
+  spec.summary       = %q{The behavior switching framework}
   spec.homepage      = 'http://magnet-inc.github.io/blue_print'
   spec.license       = 'MIT'
 
@@ -30,8 +30,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'draper'
   spec.add_development_dependency 'grape'
+  spec.add_development_dependency 'ruby-progressbar'
+  spec.add_development_dependency 'ruby-prof'
 
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'hashie'
   spec.add_dependency 'thread-parent'
 end

data/lib/blue_print/behavior.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/string/inflections'
 require 'blue_print'
 require 'blue_print/helper'
 
@@ -47,11 +49,14 @@ module BluePrint::Behavior
 
   def define_safe_method(target, punctuation, method_name)
     alias_method("#{target}_with_#{behavior_name}#{punctuation}", method_name)
+    remove_method(method_name)
 
     module_eval <<-EOC
       def #{method_name}(*args)
-        within_context_of(#{context}, proc { super(*args) }) do
+        if #{context}.active?
           #{target}_with_#{behavior_name}#{punctuation}(*args)
+        else
+          super(*args)
         end
       end
     EOC
@@ -67,6 +72,8 @@ module BluePrint::Behavior
     punctuation = Regexp.last_match ? Regexp.last_match[1] : ''
 
     define_safe_method(aliased_target, punctuation, method_name)
+
+    context.try(:reaction!)
     @ignore_added_hook = false
   end
 end

data/lib/blue_print/context.rb

@@ -27,20 +27,25 @@ class BluePrint::Context
   end
 
   def self.active?
-    return BluePrint.env[context_name] if BluePrint.env.key?(context_name)
-
-    action!
-
-    BluePrint.env[context_name] =
+    BluePrint.env.fetch(context_name) do
       !!active_ifs.inject(active_ifs.first.try(:active?)) do |memo, active_if|
         memo && active_if.active?
       end
+    end
   end
 
   def self.deactive?
     !active?
   end
 
+  def self.activate!
+    BluePrint.env[context_name] = true
+  end
+
+  def self.deactivate!
+    BluePrint.env[context_name] = false
+  end
+
   def self.casting
     @casting ||= Hash.new { |casting, klass| casting[klass] = [] }
   end
@@ -49,6 +54,8 @@ class BluePrint::Context
     as = [as] unless as.kind_of?(Array)
     as.map! { |role| role.is_a?(Module) ? role : role.to_s.safe_constantize }
     casting[actor] = casting[actor] | as
+
+    reaction!
   end
 
   def self.action!
@@ -62,4 +69,9 @@ class BluePrint::Context
 
     @acted = true
   end
+
+  def self.reaction!
+    @acted = false
+    action!
+  end
 end

data/lib/blue_print/environment.rb

@@ -1,9 +1,8 @@
-require 'hashie'
 require 'blue_print'
 
-class BluePrint::Environment < Hashie::Mash
+class BluePrint::Environment < Hash
   def initialize(context, default = nil)
-    super({}, default)
+    super(default)
     @context = context
   end
 

data/lib/blue_print/integration/rspec.rb

@@ -5,6 +5,10 @@ module BluePrint::Integration::RSpec
   extend ActiveSupport::Concern
 
   included do
+    before(:each) do
+      BluePrint.env = BluePrint::Environment.new(self)
+    end
+
     after(:each) do
       BluePrint.clear!
     end

data/lib/blue_print/version.rb

@@ -1,3 +1,3 @@
 module BluePrint
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/lib/generators/rspec/templates/context_spec.rb

@@ -2,10 +2,10 @@ require 'spec_helper'
 
 describe <%= class_name %>Context do
   context 'in active' do
-    before { described_class.stub(active?: true) }
+    before { described_class.activate! }
   end
 
   context 'in deactive' do
-    before { described_class.stub(active?: false) }
+    before { described_class.deactivate! }
   end
 end

data/profile/method_call.rb

@@ -0,0 +1,39 @@
+require 'blue_print'
+require 'ruby-prof'
+
+BluePrint.env = BluePrint::Environment.new({})
+
+class Base
+  def name
+    :base
+  end
+end
+
+class ProfileContext < BluePrint::Context
+  module Extended
+    def name
+      :extended
+    end
+  end
+
+  cast Base, as: Extended
+end
+
+ITERATION = 100000
+
+RubyProf.start
+
+ProfileContext.activate!
+ITERATION.times do
+  Base.new.name
+end
+
+ProfileContext.deactivate!
+ITERATION.times do
+  Base.new.name
+end
+
+result = RubyProf.stop
+
+printer = RubyProf::FlatPrinter.new(result)
+printer.print(STDOUT)

data/spec/lib/blue_print/behavior_spec.rb

@@ -1,10 +1,6 @@
 require 'spec_helper'
 
-module TestContext
-  def self.active?
-    true
-  end
-
+class TestContext < BluePrint::Context
   module TestBehavior
     extend BluePrint::Behavior
 
@@ -60,6 +56,8 @@ describe BluePrint::Behavior do
   end
   let(:target) { target_class.new }
 
+  before { TestContext.activate! }
+
   shared_examples 'as behavior' do
     describe '#context_name' do
       subject { behavior.context_name }

data/spec/lib/blue_print/context_spec.rb

@@ -52,10 +52,6 @@ describe BluePrint::Context do
 
     subject { context.active? }
 
-    before do
-      BluePrint.env = BluePrint::Environment.new(self)
-    end
-
     context 'with always actives' do
       before do
         context.active_if(always_active, always_active)
@@ -103,6 +99,24 @@ describe BluePrint::Context do
     end
   end
 
+  describe '#activate!' do
+    before do
+      context.active_if { false }
+      context.activate!
+    end
+
+    it { should be_active }
+  end
+
+  describe '#deactivate!' do
+    before do
+      context.active_if { true }
+      context.deactivate!
+    end
+
+    it { should be_deactive }
+  end
+
   describe '#cast' do
     let(:klass) { Class.new }
     let(:role) { Module.new }
@@ -124,8 +138,6 @@ describe BluePrint::Context do
 
     before do
       context.cast(klass, as: role)
-      context.instance_variable_set(:@acted, false)
-      context.action!
     end
 
     it 'be act role' do

data/spec/lib/blue_print/environment_spec.rb

@@ -4,13 +4,13 @@ describe BluePrint::Environment do
   let(:context) { double(a: 1) }
   subject(:env) { described_class.new(context) }
 
-  describe '#with' do
+  describe '#within' do
     it 'keeps scope' do
       b = 2
-      env.rspec = self
-      env.with do |env|
-        env.rspec.expect(a).to env.rspec.eq(1)
-        env.rspec.expect(b).to env.rspec.eq(2)
+      env[:rspec] = self
+      env.within do |env|
+        env[:rspec].expect(a).to env[:rspec].eq(1)
+        env[:rspec].expect(b).to env[:rspec].eq(2)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blue_print
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Sho Kusano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-15 00:00:00.000000000 Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -193,13 +193,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -207,7 +207,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -248,6 +262,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmark/pure.rb
+- benchmark/with_blue_print.rb
+- benchmark/with_extend.rb
 - blue_print.gemspec
 - gemfiles/rails-3.x.gemfile
 - gemfiles/rails-4.x.gemfile
@@ -278,6 +295,7 @@ files:
 - lib/generators/rspec/blue_print_generator.rb
 - lib/generators/rspec/templates/context_spec.rb
 - lib/generators/rspec/templates/role_spec.rb
+- profile/method_call.rb
 - spec/apis/application_api_spec.rb
 - spec/dummy/.gitignore
 - spec/dummy/Gemfile
@@ -359,7 +377,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: The behavior switching framework for Rails
+summary: The behavior switching framework
 test_files:
 - spec/apis/application_api_spec.rb
 - spec/dummy/.gitignore