chanko 2.0.0 → 2.0.1

data/.travis.yml

@@ -1,5 +1,7 @@
-language: ruby
 rvm:
   - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
+branches:
+  only:
+    - master

data/README.md

@@ -1,11 +1,14 @@
-# Chanko
+# Chanko [![Build Status](https://travis-ci.org/cookpad/chanko.png)](https://travis-ci.org/cookpad/chanko) [![Code Climate](https://codeclimate.com/github/cookpad/chanko.png)](https://codeclimate.com/github/cookpad/chanko) [![Coverage Status](https://coveralls.io/repos/cookpad/chanko/badge.png?branch=master)](https://coveralls.io/r/cookpad/chanko)
+
+http://cookpad.github.com/chanko/
+
 Chanko provides a simple framework for rapidly and safely prototyping new
 features in your production Rails app, and exposing these prototypes to
 specified segments of your user base.
 
-With Chanko, you can release many concurrent features and independently manage
-which users see them. If there are errors with any chanko, it will be
-automatically removed, without impacting your site.
+With Chanko, you can release many features concurrently and manage target users independently.
+When any errors are raised from chanko's features,
+it will be automatically hidden and fallback to its normal behavior.
 
 
 ## Requirements
@@ -21,10 +24,19 @@ gem "chanko"
 ```
 
 ## Files
-Chanko provides a generator to create a template of unit.
+Chanko provides a generator to create templates of an unit.
 
 ```
-$ rails generate chanko:install example_unit
+$ rails generate chanko:unit example_unit
+      create  app/units/example_unit
+      create  app/units/example_unit/example_unit.rb
+      create  app/units/example_unit/views/.gitkeep
+      create  app/units/example_unit/images/.gitkeep
+      create  app/units/example_unit/javascripts/.gitkeep
+      create  app/units/example_unit/stylesheets/.gitkeep
+      create  app/assets/images/units/example_unit
+      create  app/assets/javascripts/units/example_unit
+      create  app/assets/stylesheets/units/example_unit
 ```
 
 ## Invoke
@@ -57,6 +69,7 @@ end
 ```
 
 ## Unit
+You can see [the real example of an unit module file](https://github.com/cookpad/chanko/blob/master/spec/dummy/app/units/entry_deletion/entry_deletion.rb).
 
 ### module
 You can define your MVC code here.
@@ -163,6 +176,8 @@ Chanko provides an example rails application in spec/dummy directory.
 ```
 $ git clone git@github.com:cookpad/chanko.git
 $ cd chanko/spec/dummy
+$ bundle install
+$ bundle exec rake db:create db:migrate
 $ rails s
 $ open http://localhost:3000
 ```

data/Rakefile

@@ -1,12 +1,5 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-begin
-  require "rspec/core/rake_task"
-  RSpec::Core::RakeTask.new(:spec) do |spec|
-    spec.pattern = "spec/**/*_spec.rb"
-    spec.rspec_opts = ["-cfs"]
-  end
-rescue LoadError => e
-end
-
+RSpec::Core::RakeTask.new(:spec)
 task :default => :spec

data/chanko.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "rails", ">= 3.0.10"
   gem.add_development_dependency "coffee-rails", ">= 3.0.10"
+  gem.add_development_dependency "coveralls"
   gem.add_development_dependency "jquery-rails"
   gem.add_development_dependency "pry"
   gem.add_development_dependency "rspec-rails", "2.12.2"

data/lib/chanko/active_if.rb

@@ -33,26 +33,43 @@ module Chanko
     def blocks
       @blocks ||= begin
         conditions.map do |condition|
-          condition.is_a?(Any) ? condition.to_block : self.class.find(condition)
+          Block.new(condition)
         end << @block
       end.compact
     end
 
-    class Any
-      def initialize(*labels)
-        @labels = labels
+    class Block
+      def initialize(*conditions)
+        @conditions = conditions
       end
 
-      def to_block
+      def call(context, options)
+        block.call(context, options)
+      end
+
+      def block
+        condition = @conditions.first
+        condition.is_a?(Block) ? condition : ActiveIf.find(condition)
+      end
+    end
+
+    class Any < Block
+      def block
         proc do |context, options|
-          definitions.any? do |definition|
-            definition.call(context, options)
+          @conditions.any? do |condition|
+            Block.new(condition).call(context, options)
           end
         end
       end
+    end
 
-      def definitions
-        @labels.map {|label| ActiveIf.find(label) }
+    class None < Block
+      def block
+        proc do |context, options|
+          @conditions.none? do |condition|
+            Block.new(condition).call(context, options)
+          end
+        end
       end
     end
   end

data/lib/chanko/config.rb

@@ -7,6 +7,7 @@ module Chanko
         :cache_units,
         :compatible_css_class,
         :enable_logger,
+        :propagated_errors,
         :proxy_method_name,
         :raise_error,
         :resolver,
@@ -18,6 +19,7 @@ module Chanko
         self.backtrace_limit      = 10
         self.compatible_css_class = false
         self.enable_logger        = true
+        self.propagated_errors    = []
         self.proxy_method_name    = :unit
         self.raise_error          = Rails.env.development?
         self.resolver             = ActionView::OptimizedFileSystemResolver

data/lib/chanko/exception_handler.rb

@@ -1,10 +1,37 @@
 module Chanko
-  module ExceptionHandler
-    class << self
-      def handle(exception, unit = nil)
-        Logger.debug(exception)
-        raise exception if unit.try(:raise_error?) || Config.raise_error
+  class ExceptionHandler
+    def self.handle(*args)
+      new(*args).handle
+    end
+
+    attr_reader :exception, :unit
+
+    def initialize(exception, unit = nil)
+      @exception = exception
+      @unit      = unit
+    end
+
+    def handle
+      if propagated?
+        raise exception
+      else
+        log
+        raise exception if raised?
       end
     end
+
+    private
+
+    def propagated?
+      Config.propagated_errors.any? {|klass| exception.is_a?(klass) }
+    end
+
+    def raised?
+      unit.try(:raise_error?) || Config.raise_error
+    end
+
+    def log
+      Logger.debug(exception)
+    end
   end
 end

data/lib/chanko/unit.rb

@@ -49,6 +49,10 @@ module Chanko
         ActiveIf::Any.new(*labels)
       end
 
+      def none(*labels)
+        ActiveIf::None.new(*labels)
+      end
+
       def raise_error
         @raise_error = true
       end
@@ -67,7 +71,7 @@ module Chanko
       end
 
       def view_path
-        "#{Config.units_directory_path}/#{unit_name}/views"
+        Rails.root.join("#{Config.units_directory_path}/#{unit_name}/views").to_s
       end
 
       def find_function(identifier, label)

data/lib/chanko/version.rb

@@ -1,3 +1,3 @@
 module Chanko
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/chanko/exception_handler_spec.rb

@@ -14,6 +14,27 @@ module Chanko
       Exception.new
     end
 
+    context "when Config.propagated_errors includes given error" do
+      before do
+        Config.propagated_errors << Exception
+      end
+
+      it "raises up error without any logging" do
+        Logger.should_not_receive(:debug)
+        expect { described_class.handle(error, insensitive_unit) }.to raise_error
+      end
+    end
+
+    context "when Config.propagated_errors does not include given error" do
+      before do
+        Config.propagated_errors << StandardError
+      end
+
+      it "raises up no error" do
+        expect { described_class.handle(error, insensitive_unit) }.not_to raise_error
+      end
+    end
+
     context "when Config.raise_error is false" do
       it "raises up no error" do
         expect { described_class.handle(error, insensitive_unit) }.not_to raise_error

data/spec/chanko/unit_spec.rb

@@ -14,7 +14,7 @@ module Chanko
       Class.new { include Chanko::Helper }.new
     end
 
-    describe ".active_if" do
+    describe "about active_if" do
       before do
         ActiveIf.define(:true) { true }
         ActiveIf.define(:false) { false }
@@ -26,38 +26,102 @@ module Chanko
 
       subject { unit.active?(view) }
 
-      context "in default configuration" do
-        it "is configured to return always true" do
-          should be_true
+      describe ".active_if" do
+        context "in default configuration" do
+          it "is configured to return always true" do
+            should be_true
+          end
+        end
+
+        context "when labels are specified" do
+          before do
+            unit.active_if(:true, :false)
+          end
+          specify "all of defined conditions must pass" do
+            should be_false
+          end
+        end
+
+        context "when block is passed" do
+          before do
+            unit.active_if(:true) { false }
+          end
+          specify "all of defined conditions and block must pass" do
+            should be_false
+          end
         end
       end
 
-      context "when labels are specified" do
-        before do
-          unit.active_if(:true, :false)
+      describe ".any" do
+        context "when conditions returned true and false" do
+          before do
+            unit.instance_eval do
+              active_if any(:true, :false)
+            end
+          end
+          it { should be_true }
         end
-        specify "all of defined conditions must pass" do
-          should be_false
+
+        context "when all conditions returned false" do
+          before do
+            unit.instance_eval do
+              active_if any(:false, :false)
+            end
+          end
+          it { should be_false }
         end
       end
 
-      context "when block is passed" do
-        before do
-          unit.active_if(:true) { false }
+      describe ".none" do
+        context "when all conditions returned false" do
+          before do
+            unit.instance_eval do
+              active_if none(:false, :false)
+            end
+          end
+          it { should be_true }
         end
-        specify "all of defined conditions and block must pass" do
-          should be_false
+
+        context "when conditions returned true and false" do
+          before do
+            unit.instance_eval do
+              active_if none(:true, :false)
+            end
+          end
+          it { should be_false }
         end
       end
 
-      context "when any is specified" do
-        before do
-          unit.instance_eval do
-            active_if any(:true, :false)
+      context "when using 'any' and 'none'" do
+        context "'any' in 'none'" do
+          before do
+            unit.instance_eval do
+              active_if none(any(:true, :false))
+            end
+          end
+          it "returns negatived result of inner-expression" do
+            should be_false
+          end
+        end
+
+        context "'none' in 'any'" do
+          before do
+            unit.instance_eval do
+              active_if any(none(:true), :false)
+            end
+          end
+          it "uses none(:true) as false" do
+            should be_false
           end
         end
-        specify "any of conditions must pass" do
-          should be_true
+
+        context "more nested" do
+          before do
+            unit.instance_eval do
+              active_if any(any(none(:false), :false), :false)
+            end
+          end
+          it { should be_true }
         end
       end
     end

data/spec/dummy/README.md

@@ -0,0 +1,12 @@
+# Chanko example
+This is an example rails application using Chanko.
+This application has a unit called EntryDeletion,
+which extends MVC logics to provide a feature to delete entries.
+
+## Start
+```
+$ bundle install
+$ bundle exec rake db:create db:migrate
+$ rails s
+$ open http://localhost:3000
+```

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require "coveralls"
+Coveralls.wear!
+
 require "simplecov"
 SimpleCov.start do
   add_filter "/spec\/fixtures/"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chanko
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.10
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -239,7 +255,7 @@ files:
 - spec/chanko/unit_proxy_spec.rb
 - spec/chanko/unit_spec.rb
 - spec/controllers/application_controller_spec.rb
-- spec/dummy/README.rdoc
+- spec/dummy/README.md
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
@@ -327,7 +343,7 @@ test_files:
 - spec/chanko/unit_proxy_spec.rb
 - spec/chanko/unit_spec.rb
 - spec/controllers/application_controller_spec.rb
-- spec/dummy/README.rdoc
+- spec/dummy/README.md
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css

data/spec/dummy/README.rdoc

@@ -1,261 +0,0 @@
-== Welcome to Rails
-
-Rails is a web-application framework that includes everything needed to create
-database-backed web applications according to the Model-View-Control pattern.
-
-This pattern splits the view (also called the presentation) into "dumb"
-templates that are primarily responsible for inserting pre-built data in between
-HTML tags. The model contains the "smart" domain objects (such as Account,
-Product, Person, Post) that holds all the business logic and knows how to
-persist themselves to a database. The controller handles the incoming requests
-(such as Save New Account, Update Product, Show Post) by manipulating the model
-and directing data to the view.
-
-In Rails, the model is handled by what's called an object-relational mapping
-layer entitled Active Record. This layer allows you to present the data from
-database rows as objects and embellish these data objects with business logic
-methods. You can read more about Active Record in
-link:files/vendor/rails/activerecord/README.html.
-
-The controller and view are handled by the Action Pack, which handles both
-layers by its two parts: Action View and Action Controller. These two layers
-are bundled in a single package due to their heavy interdependence. This is
-unlike the relationship between the Active Record and Action Pack that is much
-more separate. Each of these packages can be used independently outside of
-Rails. You can read more about Action Pack in
-link:files/vendor/rails/actionpack/README.html.
-
-
-== Getting Started
-
-1. At the command prompt, create a new Rails application:
-       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
-
-2. Change directory to <tt>myapp</tt> and start the web server:
-       <tt>cd myapp; rails server</tt> (run with --help for options)
-
-3. Go to http://localhost:3000/ and you'll see:
-       "Welcome aboard: You're riding Ruby on Rails!"
-
-4. Follow the guidelines to start developing your application. You can find
-the following resources handy:
-
-* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
-* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
-
-
-== Debugging Rails
-
-Sometimes your application goes wrong. Fortunately there are a lot of tools that
-will help you debug it and get it back on the rails.
-
-First area to check is the application log files. Have "tail -f" commands
-running on the server.log and development.log. Rails will automatically display
-debugging and runtime information to these files. Debugging info will also be
-shown in the browser on requests from 127.0.0.1.
-
-You can also log your own messages directly into the log file from your code
-using the Ruby logger class from inside your controllers. Example:
-
-  class WeblogController < ActionController::Base
-    def destroy
-      @weblog = Weblog.find(params[:id])
-      @weblog.destroy
-      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
-    end
-  end
-
-The result will be a message in your log file along the lines of:
-
-  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
-
-More information on how to use the logger is at http://www.ruby-doc.org/core/
-
-Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
-several books available online as well:
-
-* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
-* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
-
-These two books will bring you up to speed on the Ruby language and also on
-programming in general.
-
-
-== Debugger
-
-Debugger support is available through the debugger command when you start your
-Mongrel or WEBrick server with --debugger. This means that you can break out of
-execution at any point in the code, investigate and change the model, and then,
-resume execution! You need to install ruby-debug to run the server in debugging
-mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
-
-  class WeblogController < ActionController::Base
-    def index
-      @posts = Post.all
-      debugger
-    end
-  end
-
-So the controller will accept the action, run the first line, then present you
-with a IRB prompt in the server window. Here you can do things like:
-
-  >> @posts.inspect
-  => "[#<Post:0x14a6be8
-          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
-       #<Post:0x14a6620
-          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
-  >> @posts.first.title = "hello from a debugger"
-  => "hello from a debugger"
-
-...and even better, you can examine how your runtime objects actually work:
-
-  >> f = @posts.first
-  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
-  >> f.
-  Display all 152 possibilities? (y or n)
-
-Finally, when you're ready to resume execution, you can enter "cont".
-
-
-== Console
-
-The console is a Ruby shell, which allows you to interact with your
-application's domain model. Here you'll have all parts of the application
-configured, just like it is when the application is running. You can inspect
-domain models, change values, and save to the database. Starting the script
-without arguments will launch it in the development environment.
-
-To start the console, run <tt>rails console</tt> from the application
-directory.
-
-Options:
-
-* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
-  made to the database.
-* Passing an environment name as an argument will load the corresponding
-  environment. Example: <tt>rails console production</tt>.
-
-To reload your controllers and models after launching the console run
-<tt>reload!</tt>
-
-More information about irb can be found at:
-link:http://www.rubycentral.org/pickaxe/irb.html
-
-
-== dbconsole
-
-You can go to the command line of your database directly through <tt>rails
-dbconsole</tt>. You would be connected to the database with the credentials
-defined in database.yml. Starting the script without arguments will connect you
-to the development database. Passing an argument will connect you to a different
-database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
-PostgreSQL and SQLite 3.
-
-== Description of Contents
-
-The default directory structure of a generated Ruby on Rails application:
-
-  |-- app
-  |   |-- assets
-  |       |-- images
-  |       |-- javascripts
-  |       `-- stylesheets
-  |   |-- controllers
-  |   |-- helpers
-  |   |-- mailers
-  |   |-- models
-  |   `-- views
-  |       `-- layouts
-  |-- config
-  |   |-- environments
-  |   |-- initializers
-  |   `-- locales
-  |-- db
-  |-- doc
-  |-- lib
-  |   `-- tasks
-  |-- log
-  |-- public
-  |-- script
-  |-- test
-  |   |-- fixtures
-  |   |-- functional
-  |   |-- integration
-  |   |-- performance
-  |   `-- unit
-  |-- tmp
-  |   |-- cache
-  |   |-- pids
-  |   |-- sessions
-  |   `-- sockets
-  `-- vendor
-      |-- assets
-          `-- stylesheets
-      `-- plugins
-
-app
-  Holds all the code that's specific to this particular application.
-
-app/assets
-  Contains subdirectories for images, stylesheets, and JavaScript files.
-
-app/controllers
-  Holds controllers that should be named like weblogs_controller.rb for
-  automated URL mapping. All controllers should descend from
-  ApplicationController which itself descends from ActionController::Base.
-
-app/models
-  Holds models that should be named like post.rb. Models descend from
-  ActiveRecord::Base by default.
-
-app/views
-  Holds the template files for the view that should be named like
-  weblogs/index.html.erb for the WeblogsController#index action. All views use
-  eRuby syntax by default.
-
-app/views/layouts
-  Holds the template files for layouts to be used with views. This models the
-  common header/footer method of wrapping views. In your views, define a layout
-  using the <tt>layout :default</tt> and create a file named default.html.erb.
-  Inside default.html.erb, call <% yield %> to render the view using this
-  layout.
-
-app/helpers
-  Holds view helpers that should be named like weblogs_helper.rb. These are
-  generated for you automatically when using generators for controllers.
-  Helpers can be used to wrap functionality for your views into methods.
-
-config
-  Configuration files for the Rails environment, the routing map, the database,
-  and other dependencies.
-
-db
-  Contains the database schema in schema.rb. db/migrate contains all the
-  sequence of Migrations for your schema.
-
-doc
-  This directory is where your application documentation will be stored when
-  generated using <tt>rake doc:app</tt>
-
-lib
-  Application specific libraries. Basically, any kind of custom code that
-  doesn't belong under controllers, models, or helpers. This directory is in
-  the load path.
-
-public
-  The directory available for the web server. Also contains the dispatchers and the
-  default HTML files. This should be set as the DOCUMENT_ROOT of your web
-  server.
-
-script
-  Helper scripts for automation and generation.
-
-test
-  Unit and functional tests along with fixtures. When using the rails generate
-  command, template test files will be generated for you and placed in this
-  directory.
-
-vendor
-  External libraries that the application depends on. Also includes the plugins
-  subdirectory. If the app has frozen rails, those gems also go here, under
-  vendor/rails/. This directory is in the load path.