arturo 2.8.0 → 3.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e10b34b3f169fc7642d26b9e2fca3873256b27636293bfe35676e71d9149bdbf
-  data.tar.gz: 6a7849fc61643a2f2c876710aa9a155f0acd04877ee6c708e8dfd64a4fc7c86a
+  metadata.gz: 30446d1fe69cd50b3dc0fd9c74c6c7ee58d7b9f260bde78318b8a0f5b4caff54
+  data.tar.gz: bcd88c75f01ead72f559acefb0ed0ffb2c0efba71cf52c3787a7893299f43edf
 SHA512:
-  metadata.gz: d3783d7e7b12b26205262254ec63a9ea65911f6d290420fb642daa5cffa5181b81a0d550ac1fd211f7fa4768c54571fe07164db2aa4669f606cb837f9819cc05
-  data.tar.gz: d7d7f696e99869f400fadc6e8bb461e6769ab778e46b4b108c092b2a9cba82cb911e413c7e889c240ca82d8e71f3c958249bd53e34418c038d405706e9966d00
+  metadata.gz: b74df3cbf4fa5ab8be57c9dd318e0d565298b2ab48afd149586878911c6693ede1f2021a8c1ae55a56dbbe591262d1baff510812ee84c6bfaebca05e71a28b49
+  data.tar.gz: 9cd77e352e3eadcf7079de6d2c63abf17b17db2b41743f4498938e45f78f7d62fbddfe2a3b19f5ad3354fc10f57b3de5acc457f2031142bea5aeb576b5e0c9ea

data/README.md

@@ -86,6 +86,7 @@ rails g arturo:migration
 rails g arturo:initializer
 rails g arturo:routes
 rails g arturo:assets
+rails g arturo:feature_model
 ```
 
 #### Run the migration:
@@ -98,6 +99,10 @@ rake db:migrate
 
 #### Edit the configuration
 
+#### Edit the Feature model
+
+By default, the generated model `Arturo::Feature` inherits from `ActiveRecord::Base`. However, if you’re using multiple databases your models should inherit from an abstract class that specifies a database connection, not directly from `ActiveRecord::Base`. Update the generated model in `app/models/arturo/feature.rb` to make it use a correct database. 
+
 ##### Initializer
 
 Open up the newly-generated `config/initializers/arturo_initializer.rb`.

data/lib/arturo/feature.rb

@@ -1,41 +1,49 @@
 # frozen_string_literal: true
 require 'active_record'
+require 'active_support'
 
-# a stub
-# possible TODO: remove and and refactor into an acts_as_feature mixin
 module Arturo
-  class Feature < ::ActiveRecord::Base
-
+  module FeatureMethods
+    extend ActiveSupport::Concern
     include Arturo::SpecialHandling
 
-    Arturo::Feature::SYMBOL_REGEX = /^[a-zA-z][a-zA-Z0-9_]*$/
+    SYMBOL_REGEX = /^[a-zA-z][a-zA-Z0-9_]*$/
     DEFAULT_ATTRIBUTES = { :deployment_percentage => 0 }.with_indifferent_access
 
-    attr_readonly :symbol
-
-    validates_presence_of :symbol, :deployment_percentage
-    validates_uniqueness_of :symbol, :allow_blank => true, :case_sensitive => false
-    validates_numericality_of :deployment_percentage,
-                                            :only_integer => true,
-                                            :allow_blank => true,
-                                            :greater_than_or_equal_to => 0,
-                                            :less_than_or_equal_to => 100
-
-    # Looks up a feature by symbol. Also accepts a Feature as input.
-    # @param [Symbol, Arturo::Feature] feature_or_name a Feature or the Symbol of a Feature
-    # @return [Arturo::Feature, nil] the Feature if found, else Arturo::NoSuchFeature
-    def self.to_feature(feature_or_symbol)
-      return feature_or_symbol if feature_or_symbol.kind_of?(self)
-      symbol = feature_or_symbol.to_sym.to_s
-      self.where(:symbol => symbol).first || Arturo::NoSuchFeature.new(symbol)
+    included do
+      attr_readonly :symbol
+
+      validates_presence_of :symbol, :deployment_percentage
+      validates_uniqueness_of :symbol, :allow_blank => true, :case_sensitive => false
+      validates_numericality_of :deployment_percentage,
+                                :only_integer => true,
+                                :allow_blank => true,
+                                :greater_than_or_equal_to => 0,
+                                :less_than_or_equal_to => 100
     end
 
-    # Looks up a feature by symbol. Also accepts a Feature as input.
-    # @param [Symbol, Arturo::Feature] feature_or_name a Feature or the Symbol of a Feature
-    # @return [Arturo::Feature, nil] the Feature if found, else nil
-    def self.find_feature(feature_or_symbol)
-      feature = to_feature(feature_or_symbol)
-      feature.is_a?(Arturo::NoSuchFeature) ? nil : feature
+    class_methods do
+      # Looks up a feature by symbol. Also accepts a Feature as input.
+      # @param [Symbol, Arturo::Feature] feature_or_symbol a Feature or the Symbol of a Feature
+      # @return [Arturo::Feature, Arturo::NoSuchFeature] the Feature if found, else Arturo::NoSuchFeature
+      def to_feature(feature_or_symbol)
+        return feature_or_symbol if feature_or_symbol.kind_of?(self)
+
+        symbol = feature_or_symbol.to_sym.to_s
+        self.where(:symbol => symbol).first || Arturo::NoSuchFeature.new(symbol)
+      end
+
+      # Looks up a feature by symbol. Also accepts a Feature as input.
+      # @param [Symbol, Arturo::Feature] feature_or_symbol a Feature or the Symbol of a Feature
+      # @return [Arturo::Feature, nil] the Feature if found, else nil
+      def find_feature(feature_or_symbol)
+        feature = to_feature(feature_or_symbol)
+        feature.is_a?(Arturo::NoSuchFeature) ? nil : feature
+      end
+
+      def last_updated_at
+        maximum(:updated_at)
+      end
     end
 
     # Create a new Feature
@@ -59,6 +67,7 @@ module Arturo
 
     def name
       return I18n.translate("arturo.feature.nameless") if symbol.blank?
+
       I18n.translate("arturo.feature.#{symbol}", :default => symbol.to_s.titleize)
     end
 
@@ -74,10 +83,6 @@ module Arturo
       "<Arturo::Feature #{name}, deployed to #{deployment_percentage}%>"
     end
 
-    def self.last_updated_at
-      maximum(:updated_at)
-    end
-
     # made public so as to allow for thresholds stored outside of the model
     def passes_threshold?(feature_recipient, threshold)
       return true if threshold == 100

data/lib/arturo/special_handling.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+
+require 'active_support'
+
 module Arturo
 
   # Adds whitelist and blacklist support to individual features by name
@@ -25,13 +28,9 @@ module Arturo
   # This is particularly important if your application runs in several
   # different processes or on several servers.
   module SpecialHandling
+    extend ActiveSupport::Concern
 
-    def self.included(base)
-      base.extend Arturo::SpecialHandling::ClassMethods
-    end
-
-    module ClassMethods
-
+    class_methods do
       def whitelists
         @whitelists ||= []
       end

data/lib/arturo/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Arturo
-  VERSION = '2.8.0'
+  VERSION = '3.0.0.pre.1'
 end

data/lib/arturo.rb

@@ -2,6 +2,7 @@
 module Arturo
   require 'arturo/null_logger'
   require 'arturo/special_handling'
+  require 'arturo/feature'
   require 'arturo/feature_availability'
   require 'arturo/feature_management'
   require 'arturo/feature_caching'

data/lib/generators/arturo/feature_model_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'rails/generators'
+
+module Arturo
+  class FeatureModelGenerator < Rails::Generators::Base
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def copy_feature_model_file
+      copy_file "feature.rb", "app/models/arturo/feature.rb"
+    end
+  end
+end

data/lib/generators/arturo/migration_generator.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/migration'
+require 'rails/generators/active_record'
 
 module Arturo
   class MigrationGenerator < Rails::Generators::Base
@@ -10,19 +12,16 @@ module Arturo
       File.join(File.dirname(__FILE__), 'templates')
     end
 
-     # Implement the required interface for Rails::Generators::Migration.
-     # taken from
-     # http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
-    def self.next_migration_number(dirname) #:nodoc:
-      if ActiveRecord::Base.timestamped_migrations
-        Time.now.utc.strftime("%Y%m%d%H%M%S")
-      else
-        "%.3d" % (current_migration_number(dirname) + 1)
-      end
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
     end
 
     def create_migration_file
-      migration_template 'migration.rb', 'db/migrate/create_features.rb'
+      migration_template 'migration.erb', 'db/migrate/create_features.rb', { migration_version: migration_version }
+    end
+
+    def migration_version
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
     end
   end
 end

data/lib/generators/arturo/templates/feature.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+module Arturo
+  class Feature < ::ActiveRecord::Base
+    include Arturo::FeatureMethods
+  end
+end

data/lib/generators/arturo/templates/migration.erb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class CreateFeatures < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    create_table :features do |t|
+      t.string :symbol, null: false
+      t.integer :deployment_percentage, null: false
+      # Any additional fields here
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :features
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arturo
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 3.0.0.pre.1
 platform: ruby
 authors:
 - James A. Rosen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -159,12 +159,14 @@ files:
 - lib/arturo/test_support.rb
 - lib/arturo/version.rb
 - lib/generators/arturo/assets_generator.rb
+- lib/generators/arturo/feature_model_generator.rb
 - lib/generators/arturo/initializer_generator.rb
 - lib/generators/arturo/migration_generator.rb
 - lib/generators/arturo/routes_generator.rb
 - lib/generators/arturo/templates/arturo_customizations.css
+- lib/generators/arturo/templates/feature.rb
 - lib/generators/arturo/templates/initializer.rb
-- lib/generators/arturo/templates/migration.rb
+- lib/generators/arturo/templates/migration.erb
 homepage: http://github.com/zendesk/arturo
 licenses:
 - APLv2
@@ -180,9 +182,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3.1
 signing_key: 

data/lib/generators/arturo/templates/migration.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-require 'active_support/core_ext'
-
-class CreateFeatures < ActiveRecord::Migration
-  def self.up
-    create_table :features do |t|
-      t.string   :symbol, :null => false
-      t.integer  :deployment_percentage, :null => false
-      #Any additional fields here
-
-      t.timestamps
-    end
-  end
-
-  def self.down
-    drop_table :features
-  end
-end