acts_as_featureable 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.project

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in featureable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 kainage-home
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# Acts As Featureable
+
+Add a polymorphic resource to your rails app for pulling content to a main/features page.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_as_featureable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_featureable
+    
+Run the generator:
+
+    $ rails g features
+
+This will create the migration file and an initializer.
+
+Migrate the database:
+
+    $ rake db:migrate
+
+## Configuration
+
+Edit the initializer file to set default settings for feature size and auto title & summary assigning:
+
+## Usage
+
+### Featureable Model
+
+Add the appropriate line to the class you want to feature:
+
+```ruby
+class Topic
+	acts_as_featurable
+end
+```
+
+### Creating Features
+
+Add a feature to a model. The _title_ and _summary_ (or whichever methods you add in the initializer file) will be assigned:
+
+```ruby
+featureable = Topic.create(title: 'Title', summary: 'Summary')
+featureable.features.create
+#<Feature title: "Title", summary: "Summary">
+```
+
+You can also override them directly:
+
+```ruby
+featureable = Topic.create(title: 'Title', summary: 'Summary')
+featureable.features.create(title: 'My New Title', summary 'My New Summary')
+#<Feature title: "My New Title", summary: "My New Summary">
+```
+
+The _position_ of the features can be specified:
+
+```ruby
+featureable = Topic.create
+featureable.features.create(position: 3)
+#<Feature position: 3>
+```
+
+If it is not specified, it will automatically be assigned the next, lowest _position_:
+
+```ruby
+featureable = Topic.create
+featureable.features.create
+#<Feature position: 1>
+
+featureable.features.create
+#<Feature position: 2>
+```
+
+If you try and assign a position which has already been taken, it will find the next, lowest available _position_:
+
+```ruby
+featureable = Topic.create
+featureable.features.create
+#<Feature position: 1>
+
+featureable.features.create(position: 1)
+#<Feature position: 2>
+
+featureable.features.create(position: 1)
+#<Feature position: 3>
+```
+
+### Feature scope
+
+Get all features ordered by thier _position_ ascending:
+
+```ruby
+Feature.ordered
+```
+
+Implementing the forms and views is left up to the developer.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/acts_as_featureable.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_featureable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_featureable"
+  spec.version       = ActsAsFeatureable::VERSION
+  spec.authors       = ["Kainage"]
+  spec.email         = ["kainage@gmail.com"]
+  spec.description   = %q{Add a feature resource to a rails app}
+  spec.summary       = %q{Creates a new polymorphic resrouce, Feature, for pulling content to a main/features page}
+  spec.homepage      = "https://github.com/kainage/acts_as_featureable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "shoulda-matchers"
+  
+  spec.add_runtime_dependency "activerecord"
+end

data/lib/acts_as_featureable/feature.rb

@@ -0,0 +1,62 @@
+class Feature < ActiveRecord::Base
+	include ActsAsFeatureable::Feature
+	
+	before_validation :assign_title, :assign_summary, :assign_position
+	
+	validate :feature_limit_not_reached
+	
+	validates_numericality_of :position
+		
+	private
+	
+	def feature_limit_not_reached
+		limit = ActsAsFeatureable.feature_limit
+		errors.add(:base, 
+			"The feature limit of #{limit} has been reached. \
+			Please delete or change an existing feature."
+		) if 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 = Feature.select('features.position').map(&:position).sort
+		
+		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
+end

data/lib/acts_as_featureable/feature_methods.rb

@@ -0,0 +1,9 @@
+module ActsAsFeatureable
+	module Feature
+		def self.included(feature_model)
+			feature_model.belongs_to :featureable, polymorphic: true
+			
+			feature_model.scope :ordered, ->{ feature_model.order('position ASC') }
+		end
+	end
+end

data/lib/acts_as_featureable/featureable_methods.rb

@@ -0,0 +1,17 @@
+module ActiveRecord
+	module Acts
+		module Featureable
+			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::Featureable)

data/lib/acts_as_featureable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsFeatureable
+  VERSION = "0.0.1"
+end

data/lib/acts_as_featureable.rb

@@ -0,0 +1,22 @@
+require 'acts_as_featureable/version'
+require 'acts_as_featureable/featureable_methods'
+require 'acts_as_featureable/feature_methods'
+require 'acts_as_featureable/feature'
+
+module ActsAsFeatureable
+	# Set the maximum limit of features availible.
+	mattr_accessor :feature_limit
+	@@feature_limit = 10
+	
+	# Set the order of auto title assign
+	mattr_accessor :auto_title_assign_list
+	@@auto_title_assign_list = [:title, :name]
+	
+	# Set the order of auto summary assigning
+	mattr_accessor :auto_summary_assign_list
+	@@auto_summary_assign_list = [:summary, :caption, :tldr, :content, :text]
+	
+	def self.setup
+		yield self
+	end
+end

data/lib/generators/features_generator.rb

@@ -0,0 +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
+end

data/lib/generators/templates/create_features.rb

@@ -0,0 +1,13 @@
+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.timestamps
+		end
+		
+		add_index :features, [:featureable_type, :featureable_id]
+	end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,10 @@
+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]
+end

data/spec/extra/model.rb

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

data/spec/extra/schema.rb

@@ -0,0 +1,16 @@
+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.timestamps
+	end
+	
+	add_index :features, [:featureable_type, :featureable_id]
+	
+	create_table :topics do |t|
+		t.string :title
+		t.text :summary
+	end
+end

data/spec/feature_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Feature do
+	before :each do
+		Feature.delete_all
+	end
+	
+	subject { Feature.create! }
+	
+	it { should be_valid }
+	it { should belong_to :featureable }
+	it { should validate_numericality_of :position }
+	
+	## 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 
+			Feature.create!
+		end
+		
+		# Attempt to create an additional feature
+		expect { Feature.create! }.to raise_error ActiveRecord::RecordInvalid
+	end
+	
+	## TITLE ##
+	it "should assign associated model's title" do
+		@topic = Topic.new(:title => 'Title')
+		feature = Feature.create!(:featureable => @topic)
+		
+		feature.title.should eql @topic.title
+	end
+	
+	it "should overwrite associated model's title" do
+		@topic = Topic.new(:title => 'Title')
+		feature = Feature.create!(:featureable => @topic, :title => 'New Title')
+		
+		feature.title.should eql 'New Title'
+	end
+	
+	## SUMMARY ##
+	it "should assign associated model's summary" do
+		@topic = Topic.new(:summary => 'Summary')
+		feature = Feature.create!(:featureable => @topic)
+		
+		feature.summary.should eql @topic.summary
+	end
+	
+	it "should overwrite associated model's summary" do
+		@topic = Topic.new(:summary => 'Summary')
+		feature = Feature.create!(:featureable => @topic, :summary => 'New Summary')
+		
+		feature.summary.should eql 'New Summary'
+	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
+		Feature.create!(:position => 1).position.should eql 2
+	end
+end
+	

data/spec/featureable_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Topic do
+	subject { Topic.create! }
+	
+	it { should be_valid }
+	it { should have_many :features }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'active_record'
+require 'shoulda-matchers'
+require 'acts_as_featureable'
+
+ActiveRecord::Base.establish_connection(
+	:adapter => "sqlite3",
+	:database => ":memory:"
+)
+
+load(File.dirname(__FILE__) + '/extra/schema.rb')
+load(File.dirname(__FILE__) + '/extra/model.rb')

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_featureable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kainage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: activerecord
+  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: sqlite3
+  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: shoulda-matchers
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add a feature resource to a rails app
+email:
+- kainage@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_featureable.gemspec
+- lib/acts_as_featureable.rb
+- lib/acts_as_featureable/feature.rb
+- lib/acts_as_featureable/feature_methods.rb
+- lib/acts_as_featureable/featureable_methods.rb
+- lib/acts_as_featureable/version.rb
+- lib/generators/features_generator.rb
+- lib/generators/templates/create_features.rb
+- lib/generators/templates/initializer.rb
+- spec/extra/model.rb
+- spec/extra/schema.rb
+- spec/feature_spec.rb
+- spec/featureable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kainage/acts_as_featureable
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 548961575401388843
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 548961575401388843
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Creates a new polymorphic resrouce, Feature, for pulling content to a main/features
+  page
+test_files:
+- spec/extra/model.rb
+- spec/extra/schema.rb
+- spec/feature_spec.rb
+- spec/featureable_spec.rb
+- spec/spec_helper.rb