arturo 1.6.0 → 1.6.1

data/CHANGELOG.md

@@ -0,0 +1,84 @@
+## v1.6.1
+
+`Arturo::FeaturesHelper#error_messages_for` has been deprecated in favor of
+`error_messages_for_feature` because it conflicts with a Rails and DynamicForm
+method. It will be removed in v1.7.0. This only affects people who have written
+their own feature-management pages that use this helper.
+
+## v1.6.0
+
+Formerly, whitelists and blacklists had to be *feature-specific*:
+
+    Arturo::Feature.whitelist(:foo) do |recipient|
+      recipient.plan.has_foo?
+    end
+
+Now whitelists and blacklists can be global. The block takes the feature
+as the first argument:
+
+    Arturo::Feature.whitelist do |feature, recipient|
+      recipient.plan.has?(feature.to_sym)
+    end
+
+## v1.5.3
+
+Set `signing_key` in gemspec only if the file exists.
+
+The `FeaturesController` docs erroneously said to override `#permitted?`.
+The correct method name is `may_manage_features?`.
+
+## v1.5.2
+
+The gem is now signed. The public key is
+[gem-public_cert.pem](./gem-public_cert.pem).
+
+## v1.5.1
+
+Use just ActiveRecord, not all of Rails, when defining different behavior
+for different versions.
+
+Unify interface of `Feature` and `NoSuchFeature` so the latter fulfills the
+null-object pattern.
+
+## v1.5.0
+
+This project is now licensed under the
+[APLv2](https://www.apache.org/licenses/LICENSE-2.0.html).
+
+Arturo now works on Rails 3.0 and Rails 4.0. Helpers are no longer mixed into
+the global view, but are under the `arturo_engine` namespace, as is the
+convention in Rails 3.1+.
+
+The feature cache will return `NoSuchFeature` for cache misses instead of `nil`,
+which clients can treat like a `Feature` that is always off.
+
+Better error messages when managing features, and the addition of the
+`arturo_flash_messages` helper method.
+
+Add `Feature.last_updated_at` to get the most recent `updated_at` among all
+`Feature`s.
+
+## v1.3.0
+
+Add `Arturo::Middleware`, which passes requests down the stack if an only if
+a particular feature is available.
+
+`TestSupport` methods use `Feature.to_feature`.
+
+## v 1.1.0 - cleanup
+
+ * changed `require_feature!` to `require_feature`
+ * replaced `Arturo.permit_management` and `Arturo.feature_recipient`
+   blocks with instance methods
+   `Arturo::FeatureManagement.may_manage_features?` and
+   `Arturo::FeatureAvailability.feature_recipient`
+
+## v 1.0.0 - Initial Release
+
+ * `require_feature!` controller filter
+ * `if_feature_enabled` controller and view method
+ * `feature_enabled?` controller and view method
+ * CRUD for features
+ * `Arturo.permit_management` to configure management permission
+ * `Arturo.feature_recipient` to configure on what basis features are deployed
+ * whitelists and blacklists

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2012-2013 James A. Rosen
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -66,19 +66,18 @@ feature and deploy it to all users.
 
 ## Installation
 
-### In Rails 3, with Bundler
+### In Rails 3 or 4, with Bundler
 
     gem 'arturo', '~> 1.0'
 
-### In Rails 3, without Bundler
+### In Rails 3 or 4, without Bundler
 
     $ gem install arturo --version="~> 1.0"
 
 ### In Rails 2.3
 
-For Rails 2.3 support, see the
-[`rails_2_3` branch](http://github.com/jamesarosen/arturo/tree/rails_2_3)
-of Arturo.
+Rails 2.3 is no longer supported and has been archived on the
+[`rails_2_3` branch](http://github.com/jamesarosen/arturo/tree/rails_2_3).
 
 ## Configuration
 
@@ -195,6 +194,13 @@ If, on the other hand, no users on the free plan should have the
       user.account.free?
     end
 
+If you want to whitelist or blacklist large groups of features at once, you
+can move the feature argument into the block:
+
+    Arturo::Feature.whitelist do |feature, user|
+      user.account.has?(feature.to_sym)
+    end
+
 ### Feature Conditionals
 
 All that configuration is just a waste of time if Arturo didn't modify the
@@ -260,11 +266,27 @@ Both check whether the `foo` feature exists and is enabled for `recipient`.
 
 #### Caching
 
-**Note**: Arturo does not yet have caching support. Be very careful when
+**Note**: Arturo has support for caching `Feature` lookups, but doesn't yet
+integrate with Rails's caching. This means you should be very careful when
 caching actions or pages that involve feature detection as you will get
 strange behavior when a user who has access to a feature requests a page
-just after one who does not (and vice versa). The following is the
-**intended** support for caching.
+just after one who does not (and vice versa).
+
+To enable caching `Feature` lookups, mix `Arturo::FeatureCaching` into
+`Arturo::Feature` and set the `cache_ttl`. This is best done in an
+initializer:
+
+    Arturo::Feature.extend(Arturo::FeatureCaching)
+    Arturo::Feature.cache_ttl = 10.minutes
+
+You can also warm the cache on startup:
+
+    Arturo::Feature.warm_cache!
+
+This will pre-fetch all `Feature`s and put them in the cache.
+
+
+The following is the **intended** support for integration with view caching:
 
 Both the `require_feature` before filter and the `if_feature_enabled` block
 evaluation automatically append a string based on the feature's
@@ -277,3 +299,9 @@ percentage. See `Arturo::CacheSupport` for more information.
 Arturo gets its name from
 [Professor Maximillian Arturo](http://en.wikipedia.org/wiki/Maximillian_Arturo)
 on [Sliders](http://en.wikipedia.org/wiki/Sliders).
+
+## Quality Metrics
+
+[![Build Status](https://travis-ci.org/jamesarosen/arturo.png?branch=master)](https://travis-ci.org/jamesarosen/arturo)
+
+[![Code Quality](https://codeclimate.com/github/jamesarosen/arturo.png)](https://codeclimate.com/github/jamesarosen/arturo)

data/{lib/generators/arturo/templates → app/assets/stylesheets}/arturo.css

@@ -43,12 +43,12 @@ output.deployment_percentage:after { content: "%"; }
   display: block;
 }
 
-.feature_new  label + input, .feature_new  label + textarea, .feature_new  label + select, 
+.feature_new  label + input, .feature_new  label + textarea, .feature_new  label + select,
 .feature_edit label + input, .feature_edit label + textarea, .feature_edit label + select {
   margin-top: 0.5em;
 }
 
-.feature_new  input + label, .feature_new  textarea + label, .feature_new  select + label, 
+.feature_new  input + label, .feature_new  textarea + label, .feature_new  select + label,
 .feature_edit input + label, .feature_edit textarea + label, .feature_edit select + label {
   margin-top: 1.5em;
 }
@@ -56,7 +56,7 @@ output.deployment_percentage:after { content: "%"; }
 .feature_new input[type=text], .feature_edit input[type=text] { padding: 0.5em; }
 
 .feature_new  input.symbol, .feature_edit input.symbol {
-  background: transparent url('/images/semicolon.png') no-repeat 3px 4px;
+  background: transparent url('/images/colon.png') no-repeat 3px 4px;
   font-family: "DejaVu Sans Mono", "Droid Sans Mono", "Mondale", monospace;
   padding-left: 9px;
 }

data/app/helpers/arturo/features_helper.rb

@@ -37,7 +37,16 @@ module Arturo
       content_tag(:output, value, { 'for' => id, 'class' => 'deployment_percentage no_js' })
     end
 
-    def error_messages_for(feature, attribute)
+    def error_messages_for(feature, attribute, *args, &block)
+      if feature.kind_of?(Arturo::Feature)
+        warn 'Arturo::FeaturesHelper#error_messages_for has been deprecated; use #error_messages_for_feature.'
+        error_messages_for_feature(feature, attribute)
+      else
+        super
+      end
+    end
+
+    def error_messages_for_feature(feature, attribute)
       if feature.errors[attribute].any?
         content_tag(:ul, :class => 'errors') do
           feature.errors[attribute].map { |msg| content_tag(:li, msg, :class => 'error') }.join('').html_safe

data/app/views/arturo/features/_form.html.erb

@@ -4,12 +4,12 @@
 
     <%= form.label(:symbol) %>
     <%= form.text_field(:symbol, :required => 'required', :pattern => Arturo::Feature::SYMBOL_REGEX.source, :class => 'symbol') %>
-    <%= error_messages_for(feature, :symbol) %>
+    <%= error_messages_for_feature(feature, :symbol) %>
 
     <%= form.label(:deployment_percentage) %>
     <%= form.range_field(:deployment_percentage, :min => '0', :max => '100', :step => '1', :class => 'deployment_percentage') %>
     <%= deployment_percentage_output_tag 'feature_deployment_percentage', feature.deployment_percentage %>
-    <%= error_messages_for(feature, :deployment_percentage) %>
+    <%= error_messages_for_feature(feature, :deployment_percentage) %>
 
     <footer><%= form.submit %></footer>
   </fieldset>

data/lib/arturo/feature_caching.rb

@@ -48,6 +48,16 @@ module Arturo
       end
     end
 
+    # Warms the cache by fetching all `Feature`s and caching them.
+    # This is perfect for use in an initializer.
+    def warm_cache!
+      raise "Cannot warm Feature Cache; caching is disabled" unless caches_features?
+
+      all.each do |feature|
+        feature_cache.write(feature.symbol.to_sym, feature, :expires_in => cache_ttl)
+      end
+    end
+
     protected
 
     # Quack like a Rails cache.

data/lib/generators/arturo/assets_generator.rb

@@ -2,15 +2,19 @@ require 'rails/generators'
 
 module Arturo
   class AssetsGenerator < Rails::Generators::Base
+
     def self.source_root
-      File.join(File.dirname(__FILE__), 'templates')
+      Arturo::Engine.root_path
     end
 
     def copy_assets
-      copy_file 'arturo.css',                 'public/stylesheets/arturo.css', :force => true
-      copy_file 'arturo_customizations.css',  'public/stylesheets/arturo_customizations.css', :skip => true
-      copy_file 'arturo.js',                  'public/javascripts/arturo.js'
-      copy_file 'semicolon.png',              'public/images/semicolon.png'
+      copy_file 'lib/generators/arturo/templates/arturo_customizations.css',  'public/stylesheets/arturo_customizations.css', :skip => true
+
+      unless defined?(Sprockets)
+        copy_file 'app/assets/stylesheets/arturo.css', 'public/stylesheets/arturo.css', :force => true
+        copy_file 'app/assets/javascripts/arturo.js',  'public/javascripts/arturo.js'
+        copy_file 'app/assets/images/colon.png',       'public/images/colon.png'
+      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arturo
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -37,7 +37,7 @@ cert_chain:
   eExwbFhYR2tTdDNOUzhSRmhRRkNPSWRnc1hFbGpFdlpwVnh1cmk1T2JIMHpx
   eFVOWE9scQo1bEVpNTZuM0tra0tSaHUxY0U2MWdBPT0KLS0tLS1FTkQgQ0VS
   VElGSUNBVEUtLS0tLQo=
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -195,12 +195,12 @@ files:
 - lib/generators/arturo/initializer_generator.rb
 - lib/generators/arturo/migration_generator.rb
 - lib/generators/arturo/routes_generator.rb
-- lib/generators/arturo/templates/arturo.css
-- lib/generators/arturo/templates/arturo.js
 - lib/generators/arturo/templates/arturo_customizations.css
 - lib/generators/arturo/templates/initializer.rb
 - lib/generators/arturo/templates/migration.rb
-- lib/generators/arturo/templates/semicolon.png
+- app/assets/images/colon.png
+- app/assets/javascripts/arturo.js
+- app/assets/stylesheets/arturo.css
 - app/controllers/arturo/features_controller.rb
 - app/helpers/arturo/features_helper.rb
 - app/models/arturo/feature.rb
@@ -214,7 +214,8 @@ files:
 - config/locales/en.yml
 - config/routes.rb
 - README.md
-- HISTORY.md
+- CHANGELOG.md
+- LICENSE
 homepage: http://github.com/jamesarosen/arturo
 licenses:
 - APLv2

metadata.gz.sig

@@ -1 +1,2 @@
-���%c��F+�s��ӀЎT�����+��zb�����h:�0m��t�63��2�/di<jWܞ�q�{�"�8�`�L\a��R����K�m�{�Sf\��+��	�5�m�B����(��mk;�A�׺т#�Y&_U�R�7���>��P��uCչ��(�/�f�>U�X�3�8���ۼ��c���î��ځ�3y��7i���p��Yg�������QT��)�{�R��{
�3�e��uU$
+x$
+���y�֘E
��*��Ml])�@z�����T�6s�A8-q�E��4yu�� 0}�~L���8���z���k7۲K����k�׻�3
��$��"W�RM��Y�~��	uMBPO�cC�rp��~

data/HISTORY.md

@@ -1,16 +0,0 @@
-## v 1.1.0 - cleanup
- * changed `require_feature!` to `require_feature`
- * replaced `Arturo.permit_management` and `Arturo.feature_recipient`
-   blocks with instance methods
-   `Arturo::FeatureManagement.may_manage_features?` and
-   `Arturo::FeatureAvailability.feature_recipient`
-
-## v 1.0.0 - Initial Release
- * `require_feature!` controller filter
- * `if_feature_enabled` controller and view method
- * `feature_enabled?` controller and view method
- * CRUD for features
- * `Arturo.permit_management` to configure management permission
- * `Arturo.feature_recipient` to configure on what basis features are deployed
- * whitelists and blacklists
-