succession 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,66 @@
+# Succession
+
+Manage the Rails object succession easily.
+
+
+You have to privide a user manage succession for a Rails object, you can simply
+add this gem.
+
+## Installation
+
+Add to your Gemfile:
+
+    gem succession
+
+and run the bundle install command.
+After the installation type into your terminal:
+
+    rake succession:install:migrations
+
+to execute the gem's migrations.
+
+## Usage
+
+### Model
+
+To add the succession behavior, put this code into your model.
+
+    class Post < ActiveRecord::Base
+      include Succession
+
+      # Your code.
+
+    end
+
+### View
+
+There are two ways to implement the up and down rating into your view.
+
+#### 1. up_link_to, down_link_to
+
+If you want to use links add this into your view files:
+
+For up rating:
+
+    <%= up_link_to "rate up", @post%>
+
+For down rating:
+
+    <%= down_link_to "rate up", @post%>
+
+#### 1. up_link_to, down_link_to
+
+If you are more the button type, use this:
+
+For up rating:
+
+    <%= up_button_to "rate up", @post%>
+
+For down rating:
+
+    <%= down_button_to "rate up", @post%>
+
+## Copyright
+
+Copyright (c) 2013 Fadendaten GmbH. See MIT-LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Succession'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/controllers/succession/entities_controller.rb

@@ -0,0 +1,15 @@
+module Succession
+  class EntitiesController < ActionController::Base
+    def up
+      entity = Succession::Entity.find(params[:id])
+      entity.up
+      redirect_to :back
+    end
+
+    def down
+      entity = Succession::Entity.find(params[:id])
+      entity.down
+      redirect_to :back
+    end
+  end
+end

data/app/models/succession/entity.rb

@@ -0,0 +1,18 @@
+module Succession
+  class Entity < ActiveRecord::Base
+    belongs_to :parent, polymorphic: true
+
+    attr_accessible :parent_id, :parent_type, :rank
+
+    def up
+      self.rank += 1
+      self.save
+    end
+
+
+    def down
+      self.rank -= 1
+      self.save
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  match '/succession_entity/:id/up/'   => "Succession::Entities#up"
+  match '/succession_entity/:id/down/' => "Succession::Entities#down"
+end

data/db/migrate/20130809120528_create_succession_entities.rb

@@ -0,0 +1,11 @@
+class CreateSuccessionEntities < ActiveRecord::Migration
+  def change
+    create_table :succession_entities do |t|
+      t.integer :parent_id
+      t.string :parent_type
+      t.integer :rank, default: 0
+
+      t.timestamps
+    end
+  end
+end

data/lib/succession/engine.rb

@@ -0,0 +1,5 @@
+module Succession
+  class Engine < ::Rails::Engine
+    isolate_namespace Succession
+  end
+end

data/lib/succession/url_helper.rb

@@ -0,0 +1,47 @@
+module ActionView::Helpers::UrlHelper
+
+  def up_button_to(name = nil, options = {}, html_options = {}, &block)
+    if options.respond_to?(:succession_entity)
+      options = succession_entity_up_path(entity(options))
+    end
+    button_to(name,options,html_options,&block)
+  end
+
+
+  def down_button_to(name = nil, options = {}, html_options = {}, &block)
+    if options.respond_to?(:succession_entity)
+      options = succession_entity_down_path(entity(options))
+    end
+    button_to(name,options,html_options,&block)
+  end
+
+  def up_link_to(name = nil, options = {}, html_options = {}, &block)
+    if options.respond_to?(:succession_entity)
+      options = succession_entity_up_path(entity(options))
+    end
+    link_to(name,options,html_options,&block)
+  end
+
+  def down_link_to(name = nil, options = {}, html_options = {}, &block)
+    if options.respond_to?(:succession_entity)
+      options = succession_entity_down_path(entity(options))
+    end
+    link_to(name,options,html_options,&block)
+  end
+
+
+  private
+
+  def entity(options)
+    entity = options.succession_entity
+  end
+
+  def succession_entity_up_path(entity)
+    "succession_entity/#{entity.id}/up"
+  end
+
+  def succession_entity_down_path(entity)
+    "succession_entity/#{entity.id}/down"
+  end
+
+end

data/lib/succession/version.rb

@@ -0,0 +1,3 @@
+module Succession
+  VERSION = "0.1.0"
+end

data/lib/succession.rb

@@ -0,0 +1,47 @@
+require "succession/engine"
+require "succession/url_helper"
+
+
+module Succession
+  def self.included(base)
+    base.has_one :succession_entity,
+                  class_name: "Succession::Entity",
+                  as: :parent,
+                  dependent: :destroy
+    base.after_create :create_succession_entity
+  end
+
+  def rank
+    Succession::Entity.where(parent_id: self.id,
+                             parent_type: self.class.to_s).first.rank
+  end
+
+  def rank= rank
+    enity = Succession::Entity.where(parent_id: self.id,
+                             parent_type: self.class.to_s).first
+    enity.rank = rank
+    enity.save
+  end
+
+  private
+
+  def create_succession_entity
+    Succession::Entity.create!(parent_id: self.id,
+                               parent_type: self.class.to_s,
+                               rank: highest_succession_rank)
+  end
+
+  def all_succession_entities
+    Succession::Entity.where(:parent_type == self.class.to_s)
+  end
+
+  def last_sueccession_entity
+    all_succession_entities.order(:rank).last
+  end
+
+  def highest_succession_rank
+    return last_sueccession_entity.rank + 1 unless last_sueccession_entity.nil?
+    return 0
+  end
+
+end

data/lib/tasks/succession_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :succession do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: succession
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Felix Langenegger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  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'
+- !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: rspec-rails
+  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: simplecov
+  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: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: ! "The Succession gem provides a easy to use ActiveRecord\n  extension
+  to manage a specific succession."
+email:
+- felix.langenegger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/succession/entities_controller.rb
+- app/models/succession/entity.rb
+- config/routes.rb
+- db/migrate/20130809120528_create_succession_entities.rb
+- lib/succession/engine.rb
+- lib/succession/url_helper.rb
+- lib/succession/version.rb
+- lib/succession.rb
+- lib/tasks/succession_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://fadendaten.ch
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Rails Plugin to provide a user managed succession.
+test_files: []