acts_as_featureable 0.0.2 → 0.0.3

data/lib/acts_as_featureable/engine.rb

@@ -1,9 +1,9 @@
 module ActsAsFeatureable
-	class Engine < ::Rails::Engine
-		config.generators do |g|
-			g.test_framework :rspec, :fixture => false
-			g.assets false
-			g.helper false
-		end
-	end
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.assets false
+      g.helper false
+    end
+  end
 end

data/lib/acts_as_featureable/feature_additions.rb

@@ -0,0 +1,96 @@
+module ActsAsFeatureable
+  module FeatureAdditions
+    def self.included(feature_model)
+      feature_model.belongs_to :featureable, polymorphic: true
+
+      feature_model.scope :ordered, ->{ feature_model.order('position ASC') }
+
+      feature_model.before_validation :assign_title, :assign_summary, :assign_position
+
+      feature_model.validate :feature_limit_not_reached, :ensure_categories
+
+      feature_model.validates_presence_of :featureable_id, :featureable_type
+
+      feature_model.validates_numericality_of :position
+
+      private
+
+      def ensure_categories
+        cats = ::ActsAsFeatureable::categories
+        # Allow all categories if set to false
+        if cats && self.category && !cats.include?(self.category.to_sym)
+          errors.add(:category, " is not in the list [#{cats.join(',')}]")
+        end
+      end
+
+      def feature_limit_not_reached
+        limit = ActsAsFeatureable.feature_limit
+        errors.add(:base, %q{
+          The feature limit of #{limit} has been reached. \
+          Please delete or change an existing feature.
+          }) if ActsAsFeatureable.categories ? Feature.where(category: self.category).count >= limit : Feature.count >= limit
+      end
+
+      def assign_title
+        # If there is no title given, check the model.
+        # Will check for the attributes in ActsAsFeatureable.auto_title_assign_list.
+        unless self.title
+          ActsAsFeatureable.auto_title_assign_list.each do |attr|
+            if featureable.respond_to?(attr)
+              self.title = featureable.send(attr)
+              break
+            end
+          end
+        end
+      end
+
+      def assign_summary
+        # If there is no summary given, check the model.
+        # Will check for the attributes in ActsAsFeatureable.auto_summary_assign_list.
+        unless self.summary
+          ActsAsFeatureable.auto_summary_assign_list.each do |attr|
+            if featureable.respond_to?(attr)
+              self.summary = featureable.send(attr)
+              break
+            end
+          end
+        end
+      end
+
+      def assign_position
+        # If there is no position given, or the position given is already taken,
+        # assign the lowest open position. Otherwise assign it.
+        all_positions = if ActsAsFeatureable.categories
+          Feature.select('features.position, features.category').where(category: self.category).map(&:position).sort
+        else
+          Feature.select('features.position').map(&:position).sort
+        end
+
+        if !self.position || (self.position && all_positions.include?(self.position))
+          # Find lowest, non-taken position
+          (1..ActsAsFeatureable.feature_limit).each do |n|
+            next if all_positions.include? n
+            self.position = n
+            break
+          end
+        end
+      end
+
+      def feature_model.method_missing(mehtod_name, *args, &block)
+        if ActsAsFeatureable.categories &&
+            ActsAsFeatureable.categories.include?(mehtod_name)
+          self.scope mehtod_name, -> { self.where(category: mehtod_name) }
+          self.send(mehtod_name)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        (ActsAsFeatureable.categories &&
+            ActsAsFeatureable.categories.include?(method_name)) ||
+          super
+      end
+    end
+  end
+end

data/lib/acts_as_featureable/featureable_additions.rb

@@ -0,0 +1,17 @@
+module ActiveRecord
+  module Acts
+    module FeatureableAdditions
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def acts_as_featureable
+          has_many :features, :as => :featureable, :dependent => :destroy
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActiveRecord::Acts::FeatureableAdditions)

data/lib/acts_as_featureable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsFeatureable
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/generators/features_generator.rb

@@ -1,16 +1,16 @@
 require 'rails/generators/migration'
 
 class FeaturesGenerator < Rails::Generators::Base
-	include Rails::Generators::Migration
-	
-	source_root File.expand_path("../templates", __FILE__)
-	
-	def self.next_migration_number(path)
-		Time.now.utc.strftime("%Y%m%d%H%M%S")
-	end
-	
-	def create_featureable_file
-		copy_file "initializer.rb", "config/initializers/acts_as_featureable.rb"
-		migration_template "create_features.rb", "db/migrate/create_features.rb"
-	end
+  include Rails::Generators::Migration
+
+  source_root File.expand_path("../templates", __FILE__)
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def create_featureable_file
+    copy_file "initializer.rb", "config/initializers/acts_as_featureable.rb"
+    migration_template "create_features.rb", "db/migrate/create_features.rb"
+  end
 end

data/lib/generators/templates/create_features.rb

@@ -1,14 +1,14 @@
 class CreateFeatures < ActiveRecord::Migration
-	def change
-		create_table :features do |t|
-			t.references :featureable, :polymorphic => true
-			t.string :title
-			t.text :summary
-			t.integer :position, :null => false
-			t.string :category
-			t.timestamps
-		end
-		
-		add_index :features, [:featureable_type, :featureable_id]
-	end
+  def change
+    create_table :features do |t|
+      t.references :featureable, :polymorphic => true
+      t.string :title
+      t.text :summary
+      t.integer :position, :null => false
+      t.string :category
+      t.timestamps
+    end
+
+    add_index :features, [:featureable_type, :featureable_id]
+  end
 end

data/lib/generators/templates/initializer.rb

@@ -1,15 +1,15 @@
 ActsAsFeatureable.setup do |config|
-	# Set the maximum limit of features availible for your app.
-	config.feature_limit = 10
-	
-	# Set the order of auto title assigning.
-	config.auto_title_assign_list = [:title, :name]
-	
-	# Set the order of auto summary assigning.
-	config.auto_summary_assign_list = [:summary, :caption, :tldr, :content, :text]
-	
-	# Limit the categories you wish to use.
-	# => [:main, :articles, :images]
-	# false allows unlimited categories.
-	config.categories = false
+  # Set the maximum limit of features availible for your app.
+  config.feature_limit = 10
+
+  # Set the order of auto title assigning.
+  config.auto_title_assign_list = [:title, :name]
+
+  # Set the order of auto summary assigning.
+  config.auto_summary_assign_list = [:summary, :caption, :tldr, :content, :text]
+
+  # Limit the categories you wish to use.
+  # => [:main, :articles, :images]
+  # false allows unlimited categories.
+  config.categories = false
 end

data/spec/extra/model.rb

@@ -1,3 +1,3 @@
 class Topic < ActiveRecord::Base
-	acts_as_featureable
+  acts_as_featureable
 end

data/spec/extra/schema.rb

@@ -1,17 +1,17 @@
 ActiveRecord::Schema.define :version => 0 do
-	create_table :features do |t|
-		t.references :featureable, :polymorphic => true
-		t.string :title
-		t.text :summary
-		t.integer :position, :null => false
-		t.string :category
-		t.timestamps
-	end
-	
-	add_index :features, [:featureable_type, :featureable_id]
-	
-	create_table :topics do |t|
-		t.string :title
-		t.text :summary
-	end
+  create_table :features do |t|
+    t.references :featureable, :polymorphic => true
+    t.string :title
+    t.text :summary
+    t.integer :position, :null => false
+    t.string :category
+    t.timestamps
+  end
+
+  add_index :features, [:featureable_type, :featureable_id]
+
+  create_table :topics do |t|
+    t.string :title
+    t.text :summary
+  end
 end

data/spec/factories/topics.rb

@@ -1,6 +1,6 @@
 FactoryGirl.define do
-	factory :topic do
-		title "Title"
-		summary "Summary"
-	end
+  factory :topic do
+    title "Title"
+    summary "Summary"
+  end
 end

data/spec/helpers/features_helper_spec.rb

@@ -1,24 +1,24 @@
 require 'spec_helper'
 
 describe FeaturesHelper do
-	before :each do
-		@topic = Topic.create!
-	end
-	
-	describe "features_form_for" do
-		it "should render the form for a new feature" do
-			helper.feature_form_for(@topic).should =~ /id="new_feature"/
-		end
-	end
-	
-	describe "features_for" do
-		it "should be empty if there are no features for the featureable" do
-			helper.features_for(@topic).should be_blank
-		end
-		
-		it "should render a list of features" do
-			@topic.features.create!
-			helper.features_for(@topic).should =~ /class="feature"/
-		end
-	end
+  before :each do
+    @topic = Topic.create!
+  end
+
+  describe "features_form_for" do
+    it "should render the form for a new feature" do
+      helper.feature_form_for(@topic).should =~ /id="new_feature"/
+    end
+  end
+
+  describe "features_for" do
+    it "should be empty if there are no features for the featureable" do
+      helper.features_for(@topic).should be_blank
+    end
+
+    it "should render a list of features" do
+      @topic.features.create!
+      helper.features_for(@topic).should =~ /class="feature"/
+    end
+  end
 end

data/spec/models/feature_spec.rb

@@ -1,131 +1,126 @@
 require 'spec_helper'
 
 describe Feature do
-	before :each do
-		Feature.delete_all
-		@topic = Topic.create!
-	end
-	
-	subject { @topic.features.create! }
-	
-	it { should be_valid }
-	it { should belong_to :featureable }
-	it { should validate_numericality_of :position }
-	it { should validate_presence_of :featureable_id }
-	it { should validate_presence_of :featureable_type }
-	
-	## ENSURE CATEGORIES ##
-	it "should allow any categories by default" do
-		@topic.features.create!(category: 'anything').errors.count.should eql 0
-	end
-	
-	describe "with category limits" do
-		before :each do
-			ActsAsFeatureable.categories = [:default]
-		end
-		
-		it "should allow a category that is in the list" do
-			@topic.features.create(category: :default).errors.count.should eq 0
-		end
-		
-		it "should not allow a category that is not in the list" do
-			feature = @topic.features.create(category: :foo)
-			
-			feature.errors.count.should eq 1
-			feature.errors.messages.keys.should include(:category)
-		end
-		
-		## CREATE SCOPES ##
-		it "should create scopes for the default categories" do
-			Feature.default
-		end
-		
-		it "should return all the features of the scope for the deafult categories" do
-			@topic.features.create!(category: :default)
-			
-			Feature.default.size.should eq 1
-		end
-	end
-	
-	## LIMIT VALIDATION ##
-	it "should only allow the default number of features to be made" do
-		limit = ActsAsFeatureable.feature_limit
-		
-		# Create the limit of features
-		limit.times do 
-			@topic.features.create!
-		end
-		
-		# Attempt to create an additional feature
-		expect { @topic.features.create! }.to raise_error ActiveRecord::RecordInvalid
-	end
-	
-	describe "with category limits" do
-		before :each do
-			ActsAsFeatureable.categories = [:one, :two]
-			
-			limit = ActsAsFeatureable.feature_limit
-			
-			# Create the limit of features
-			limit.times do 
-				@topic.features.create!(category: :one)
-			end
-		end
-		
-		it "should only allow the default number of features per category to be made" do
-			# Attempt to create an additional feature
-			expect { @topic.features.create!(category: :one) }.to raise_error ActiveRecord::RecordInvalid
-		end
-		
-		it "should allow more features to be made of other categories when one is full" do
-			expect { @topic.features.create!(category: :two) }.to_not raise_error ActiveRecord::RecordInvalid
-		end
-	end
-	
-	## TITLE ##
-	describe "with featureable" do
-		before :each do
-			@topic = Topic.create!(:title => 'Title')
-		end
-		
-		it "should assign associated model's title" do
-			feature = @topic.features.create!(:featureable => @topic)
-			
-			feature.title.should eql @topic.title
-		end
-		
-		it "should overwrite associated model's title" do
-			feature = @topic.features.create!(:featureable => @topic, :title => 'New Title')
-			
-			feature.title.should eql 'New Title'
-		end
-		
-		## SUMMARY ##
-		it "should assign associated model's summary" do
-			feature = @topic.features.create!(:featureable => @topic)
-			
-			feature.summary.should eql @topic.summary
-		end
-		
-		it "should overwrite associated model's summary" do
-			feature = @topic.features.create!(:featureable => @topic, :summary => 'New Summary')
-			
-			feature.summary.should eql 'New Summary'
-		end
-	end
-	
-	## POSITION ##
-	it "should assign a default position" do
-		subject.position.should_not be_nil
-	end
-	
-	it "should assign a default position of 1 if there are none existing" do
-		subject.position.should eql 1
-	end
-	
-	it "should assign the next position in line if it already exists" do
-		subject
-		@topic.features.create!(:position => 1).position.should eql 2
-	end
+  before :each do
+    Feature.delete_all
+    @topic = Topic.create!
+  end
+
+  subject { @topic.features.create! }
+
+  it { should be_valid }
+  it { should belong_to :featureable }
+  it { should validate_numericality_of :position }
+  it { should validate_presence_of :featureable_id }
+  it { should validate_presence_of :featureable_type }
+
+  ## ENSURE CATEGORIES ##
+  it "should allow any categories by default" do
+    @topic.features.create!(category: 'anything').errors.count.should eql 0
+  end
+
+  describe "with category limits" do
+    before :each do
+      ActsAsFeatureable.categories = [:default]
+    end
+
+    it "should allow a category that is in the list" do
+      @topic.features.create(category: :default).errors.count.should eq 0
+    end
+
+    it "should not allow a category that is not in the list" do
+    	feature = @topic.features.create(category: :foo)
+
+      feature.errors.count.should eq 1
+      feature.errors.messages.keys.should include(:category)
+    end
+
+    ## CREATE SCOPES ##
+    it "should create scopes for the default categories" do
+      Feature.default
+    end
+
+    it "should return all the features of the scope for the deafult categories" do
+      @topic.features.create!(category: :default)
+
+      Feature.default.size.should eq 1
+    end
+  end
+
+  ## LIMIT VALIDATION ##
+  it "should only allow the default number of features to be made" do
+    # Create the limit of features
+    ActsAsFeatureable.feature_limit.times do
+      @topic.features.create!
+    end
+
+    # Attempt to create an additional feature
+    expect { @topic.features.create! }.to raise_error ActiveRecord::RecordInvalid
+  end
+
+  describe "with category limits" do
+    before :each do
+      ActsAsFeatureable.categories = [:one, :two]
+
+    	# Create the limit of features
+      ActsAsFeatureable.feature_limit.times do
+        @topic.features.create!(category: :one)
+      end
+    end
+
+    it "should only allow the default number of features per category to be made" do
+      # Attempt to create an additional feature
+      expect { @topic.features.create!(category: :one) }.to raise_error ActiveRecord::RecordInvalid
+    end
+
+    it "should allow more features to be made of other categories when one is full" do
+      expect { @topic.features.create!(category: :two) }.to_not raise_error ActiveRecord::RecordInvalid
+    end
+  end
+
+  ## TITLE ##
+  describe "with featureable" do
+    before :each do
+      @topic = Topic.create!(:title => 'Title')
+    end
+
+    it "should assign associated model's title" do
+      feature = @topic.features.create!(:featureable => @topic)
+
+      feature.title.should eql @topic.title
+    end
+
+    it "should overwrite associated model's title" do
+      feature = @topic.features.create!(:featureable => @topic, :title => 'New Title')
+
+      feature.title.should eql 'New Title'
+    end
+
+    ## SUMMARY ##
+    it "should assign associated model's summary" do
+      feature = @topic.features.create!(:featureable => @topic)
+
+      feature.summary.should eql @topic.summary
+    end
+
+    it "should overwrite associated model's summary" do
+      feature = @topic.features.create!(:featureable => @topic, :summary => 'New Summary')
+
+      feature.summary.should eql 'New Summary'
+    end
+  end
+
+  ## POSITION ##
+  it "should assign a default position" do
+    subject.position.should_not be_nil
+  end
+
+  it "should assign a default position of 1 if there are none existing" do
+    subject.position.should eql 1
+  end
+
+  it "should assign the next position in line if it already exists" do
+    subject
+    @topic.features.create!(:position => 1).position.should eql 2
+  end
 end
-