acts_as_featureable 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fd7ae3319ca73121825929c08ffed994ed1da4d
+  data.tar.gz: 1b0d23f470a30c8f5a4b56f9e78064c9dec180c2
+SHA512:
+  metadata.gz: 6da70932bd2a8635194ddefa226dd36086f2a788d3c532bf94a02eabff9905b1093ec4d7216a39a6c73547babcbddbd739e5d03dd1edaee27dba2e90bd75b93c
+  data.tar.gz: 9ad74f02e91c5a73c5196e88f80b6be92250dd31b2b4981e1f2804eccebba15bd7a9fc3677b3a2f55c407130ba0b56fd6ebb8c52878cde9ffba92af51bf618ec

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v0.0.2
+
+* enhancements
+	* Added categories
+	* Added validations
+	* Turned into Rails::Engine with controller (with CanCan support) and basic views
+	* Added 2 helper methods 'feature_form_for' and 'features_for' for creating a quick form and a list of features for a given featureable
+
 ## v0.0.1
 
 * initial release

data/README.md

@@ -1,5 +1,9 @@
 # Acts As Featureable
 
+[![Build Status](https://travis-ci.org/kainage/acts_as_featureable.png)](https://travis-ci.org/kainage/acts_as_featureable)
+
+Requires ruby *1.9.3* or later
+
 Add a polymorphic resource to your rails app for pulling content to a main/features page.
 
 ## Installation
@@ -44,6 +48,19 @@ class Topic
 end
 ```
 
+Add the routes to your _routes_ config file for the resource(s) you wish to make featureable
+
+```ruby
+resources :topics do
+	resources :features
+end
+```
+
+### CanCan integration
+
+If you are using CanCan for authorization, the _features controller_ will automatically add authorization
+to each action.
+
 ### Creating Features
 
 Add a feature to a model. The _title_ and _summary_ (or whichever methods you add in the initializer file) will be assigned:
@@ -51,7 +68,7 @@ Add a feature to a model. The _title_ and _summary_ (or whichever methods you ad
 ```ruby
 featureable = Topic.create(title: 'Title', summary: 'Summary')
 featureable.features.create
-#<Feature title: "Title", summary: "Summary">
+# => <Feature title: "Title", summary: "Summary">
 ```
 
 You can also override them directly:
@@ -59,7 +76,7 @@ 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">
+# => <Feature title: "My New Title", summary: "My New Summary">
 ```
 
 The _position_ of the features can be specified:
@@ -67,7 +84,7 @@ The _position_ of the features can be specified:
 ```ruby
 featureable = Topic.create
 featureable.features.create(position: 3)
-#<Feature position: 3>
+# => <Feature position: 3>
 ```
 
 If it is not specified, it will automatically be assigned the next, lowest _position_:
@@ -75,10 +92,10 @@ If it is not specified, it will automatically be assigned the next, lowest _posi
 ```ruby
 featureable = Topic.create
 featureable.features.create
-#<Feature position: 1>
+# => <Feature position: 1>
 
 featureable.features.create
-#<Feature position: 2>
+# => <Feature position: 2>
 ```
 
 If you try and assign a position which has already been taken, it will find the next, lowest available _position_:
@@ -86,15 +103,50 @@ If you try and assign a position which has already been taken, it will find the
 ```ruby
 featureable = Topic.create
 featureable.features.create
-#<Feature position: 1>
+# => <Feature position: 1>
 
 featureable.features.create(position: 1)
-#<Feature position: 2>
+# => <Feature position: 2>
 
 featureable.features.create(position: 1)
-#<Feature position: 3>
+# => <Feature position: 3>
+```
+
+### Categories
+
+You can specify categories when creating features:
+
+```ruby
+featureable = Topic.create
+featureable.features.create(category: :mains)
+# => <Feature category: "mains">
+```
+
+You can specify any category and as many as you like to pull to different parts of your site.
+
+```ruby
+featureable = Topic.create
+featureable.features.create(category: :mains)
+# => <Feature category: "mains">
+featureable.features.create(category: :hot_topics)
+# => <Feature category: "hot_topics">
+
+featureable.features.count
+# => 2
+
+featureable.features.where(category: :hot_topics).count
+# => 1
+```
+
+This is the default behaviour. If you specify categories in your ```acts_as_featureable.rb``` initilaizer file:
+
+```ruby
+config.categories = [:mains, :hot_topics]
 ```
 
+then these are the only allowable categories for your application. You also get the side benefit of 
+having a scope created for each of these categories on the Feature class. See the next section for more details.
+
 ### Feature scope
 
 Get all features ordered by thier _position_ ascending:
@@ -103,7 +155,29 @@ Get all features ordered by thier _position_ ascending:
 Feature.ordered
 ```
 
-Implementing the forms and views is left up to the developer.
+If you have specified strict categories in your initializer (see previous section) then you can use those as scopes
+on the Feature class:
+
+```ruby
+Feature.hot_topics
+# => <Feature category: "hot_topics" ... >
+```
+
+## View Helpers
+
+Adds two helper methods to your views:
+
+```ruby
+<%= feature_form_for(featureable) %>
+```
+
+Which renders a basic form for creating features from a featureable object.
+
+```ruby
+<%= features_for(featureable) %>
+```
+
+Which simiply lists the features' position and category with a delete link
 
 ## Contributing
 

data/Rakefile

@@ -1,6 +1,23 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+begin
+	require 'bundler/setup'
+rescue LoadError
+	puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+desc "Run all specs in spec directory (excluding plugin specs)"
+
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
 
-task default: :spec
+task :default => :spec

data/acts_as_featureable.gemspec

@@ -4,26 +4,26 @@ $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.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.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"
+	spec.add_dependency "rails", "~> 4.0.0.rc1"
+
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rake"
+	spec.add_development_dependency "rspec"
+	spec.add_development_dependency "sqlite3"
+	spec.add_development_dependency "shoulda-matchers"
+	spec.add_development_dependency "rspec-rails"
 end

data/app/controllers/features_controller.rb

@@ -0,0 +1,90 @@
+class FeaturesController < ApplicationController
+	authorize_resource if defined?(CanCan::Ability)
+	
+	before_filter :find_featureable
+	
+	def index
+		@features = Feature.all
+
+		respond_to do |format|
+			format.html 
+			format.json { render json: @features }
+		end
+	end
+
+	def show
+		@feature = Feature.find(params[:id])
+
+		respond_to do |format|
+			format.html 
+			format.json { render json: @feature }
+		end
+	end
+
+	def new
+		@feature = @featureable.features.build
+
+		respond_to do |format|
+			format.html
+			format.json { render json: @feature }
+		end
+	end
+
+	def edit
+		@feature = Feature.find(params[:id])
+		
+		respond_to do |format|
+			format.html
+			format.json { render json: @feature }
+		end
+	end
+
+	def create
+		@feature = @featureable.features.build(feature_params)
+		
+		respond_to do |format|
+			if @feature.save
+				format.html { redirect_to @featureable, notice: 'Feature was successfully created.' }
+				format.json { render json: @feature, status: :created, location: @feature }
+			else
+				format.html { redirect_to @featureable, alert: @feature.errors.full_messages.join(',') }
+				format.json { render json: @feature.errors, status: :unprocessable_entity }
+			end
+		end
+	end
+	
+	def update
+		@feature = Feature.find(params[:id])
+		
+		respond_to do |format|
+			if @feature.update(feature_params)
+				format.html { redirect_to @featureable, notice: 'Feature was successfully updated.' }
+				format.json { head :no_content }
+			else
+				format.html { redirect_to @featureable, alert: @feature.errors.full_messages.join(',') }
+				format.json { render json: @feature.errors, status: :unprocessable_entity }
+			end
+		end
+	end
+
+	def destroy
+		@feature = Feature.find(params[:id])
+		@feature.destroy
+
+		respond_to do |format|
+			format.html { redirect_to @featureable, notice: 'Feature was successfully removed.' }
+			format.json { head :no_content }
+		end
+	end
+
+	private
+	
+	def feature_params
+		params.require(:feature).permit(:position, :category)
+	end
+
+	def find_featureable
+		resource, id = request.path.split('/')[1, 2]
+		@featureable = resource.singularize.classify.constantize.find(id)
+	end
+end

data/app/helpers/features_helper.rb

@@ -0,0 +1,9 @@
+module FeaturesHelper
+	def feature_form_for(featureable)
+		render 'features/form', :featureable => featureable
+	end
+	
+	def features_for(featureable)
+		render 'features/features', :featureable => featureable
+	end
+end

data/{lib/acts_as_featureable → app/models}/feature.rb

@@ -3,18 +3,28 @@ class Feature < ActiveRecord::Base
 	
 	before_validation :assign_title, :assign_summary, :assign_position
 	
-	validate :feature_limit_not_reached
+	validate :feature_limit_not_reached, :ensure_categories
+	
+	validates_presence_of :featureable_id, :featureable_type
 	
 	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, 
 			"The feature limit of #{limit} has been reached. \
 			Please delete or change an existing feature."
-		) if Feature.count >= limit
+		) if ActsAsFeatureable.categories ? Feature.where(category: self.category).count >= limit : Feature.count >= limit
 	end
 	
 	def assign_title
@@ -48,7 +58,11 @@ class Feature < ActiveRecord::Base
 	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
+		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

data/app/views/features/_feature.html.erb

@@ -0,0 +1,5 @@
+<div class="feature">
+	<%= content_tag :span, feature.position, :class => 'position' %>
+	<%= content_tag :span, feature.category, :class => 'category' %>
+	<%= link_to 'Remove', [feature.featureable, feature], :method => :delete, :data => { :confirm => 'Are you sure?' } %>
+</div>

data/app/views/features/_features.html.erb

@@ -0,0 +1,3 @@
+<% featureable.features.each do |feature| %>
+	<%= render feature %>
+<% end unless featureable.features.empty? %>

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

@@ -0,0 +1,19 @@
+<% cats = ActsAsFeatureable.categories %>
+
+<%= form_for [featureable, Feature.new] do |f| %>
+	<div class="field">
+		<%= f.label :position %>
+		<%= f.select :position, (1..ActsAsFeatureable.feature_limit) %>
+	</div>
+	
+	<div class="field">
+		<%= f.label :category%>
+		<% if cats %>
+			<%= f.select :category, cats %>
+		<% else %>
+			<%= f.text_field :category %>
+		<% end %>
+	</div>
+	
+	<%= f.submit %>
+<% end %>

data/app/views/features/edit.html.erb

@@ -0,0 +1 @@
+<%= render 'form' %>

data/app/views/features/index.html.erb

@@ -0,0 +1,3 @@
+<% @features.each do |feature| %>
+	<%= render feature %>
+<% end %>

data/app/views/features/new.html.erb

@@ -0,0 +1 @@
+<%= render 'form' %>

data/app/views/features/show.html.erb

@@ -0,0 +1 @@
+<%= render @feature %>

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/cts_as_featureable/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/lib/acts_as_featureable/config.rb

@@ -0,0 +1,30 @@
+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]
+	
+	# Limit the categories you wish to use.
+	# This should be an array of symbols
+	# [:main, :articles, :images]
+	#
+	# false allows unlimited categories.
+	#
+	# The benefit of using this is gaining the scopes for which categories you include.
+	#
+	# Feature.articles
+	# => [<# Feature > ,<# Feature>]
+	mattr_accessor :categories
+	@@categories = false
+	
+	def self.setup
+		yield self
+	end
+end

data/lib/acts_as_featureable/engine.rb

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

data/lib/acts_as_featureable/feature_methods.rb

@@ -4,6 +4,17 @@ module ActsAsFeatureable
 			feature_model.belongs_to :featureable, polymorphic: true
 			
 			feature_model.scope :ordered, ->{ feature_model.order('position ASC') }
+			
+			def feature_model.method_missing(meth, *args, &block)
+				if ::ActsAsFeatureable.categories.include?(meth)
+					self.scope meth, -> { self.where(category: meth) }
+					self.send(meth)
+				else
+					super
+				end
+			end
+			
+			feature_model.send(:private, :method_missing)
 		end
 	end
 end

data/lib/acts_as_featureable/version.rb

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

data/lib/acts_as_featureable.rb

@@ -1,22 +1,8 @@
+require 'acts_as_featureable/engine'
+
+require 'active_support/core_ext/module/attribute_accessors'
+require 'acts_as_featureable/config'
+
 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/templates/create_features.rb

@@ -5,6 +5,7 @@ class CreateFeatures < ActiveRecord::Migration
 			t.string :title
 			t.text :summary
 			t.integer :position, :null => false
+			t.string :category
 			t.timestamps
 		end
 		

data/lib/generators/templates/initializer.rb

@@ -7,4 +7,9 @@ ActsAsFeatureable.setup do |config|
 	
 	# 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