simple_acts_as_list 0.0.1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 1.8.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2013 Redu Educational Technologies
+
+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,57 @@
+# SimpleActsAsList [![Build Status](https://travis-ci.org/redu/simple_acts_as_list.png?branch=master)](https://travis-ci.org/redu/simple_acts_as_list) [![Dependency Status](https://gemnasium.com/redu/simple_acts_as_list.png)](https://gemnasium.com/redu/simple_acts_as_list)
+
+Provides very simple list behavior.
+Based on [acts_as_list gem](https://github.com/swanandp/acts_as_list).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_acts_as_list'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_acts_as_list
+
+## Usage
+
+You just need to include the model and specify the scope. Of course, the object need to have :
+1. An accessor for the collection, for example `items`.
+2. And column responsible to order the items in the list (`position`).
+
+```ruby
+class TodoList ; end
+
+class Item
+  include ActsAsList
+  simple_acts_as_list :scope => :todo_list_id
+end
+```
+
+## 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
+
+
+<img src="https://github.com/downloads/redu/redupy/redutech-marca.png" alt="Redu Educational Technologies" width="300">
+
+This project is maintained and funded by [Redu Educational Techologies](http://tech.redu.com.br).
+
+# Copyright
+
+Copyright (c) 2013 Redu Educational Technologies
+
+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/Rakefile

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

data/lib/simple_acts_as_list.rb

@@ -0,0 +1,6 @@
+require "simple_acts_as_list/version"
+require "simple_acts_as_list/model_additions"
+
+module SimpleActsAsList
+  # Your code goes here...
+end

data/lib/simple_acts_as_list/model_additions.rb

@@ -0,0 +1,102 @@
+require 'active_support'
+
+module SimpleActsAsList::ModelAdditions
+  # Provides very simple list's behavior.
+  #
+  # A minimal implementation could be:
+  #
+  # class Item
+  #   include SimpleActsAsList::ModelAdditions
+  #   simple_acts_as_list :scope => :todo_list_id
+  # end
+
+  extend ActiveSupport::Concern
+
+  included do
+    before_create :update_position
+  end
+
+  module ClassMethods
+    # Adds methods to consult informations about the list where the element belongs
+    #
+    # :scope => Attribute that defines the list scope
+    def simple_acts_as_list(opts={})
+      cattr_accessor :simple_acts_as_list_scope_id
+      self.simple_acts_as_list_scope_id = opts[:scope]
+    end
+
+    # Scope that returns item's list ordered by position
+    def simple_acts_as_list_scope(scope_id)
+      self.where(
+        "#{self.table_name}.#{self.simple_acts_as_list_scope_id}" => scope_id).
+        order("#{self.table_name}.position")
+    end
+  end
+
+  # Returns +true+ if the item is the last one of the list
+  def last_item?
+    self.simple_acts_as_list_scope.last == self
+  end
+
+  # Returns +true+ if the item is the first one of the list
+  def first_item?
+    self.simple_acts_as_list_scope.first == self
+  end
+
+  # Returns last list item
+  def last_item
+    self.simple_acts_as_list_scope.last
+  end
+
+  # Returns first list item
+  def first_item
+    self.simple_acts_as_list_scope.first
+  end
+
+  # Returns next list item
+  #
+  # Returns +nil+ if the item is the last one of the list
+  def next_item
+    index = self.simple_acts_as_list_scope.index(self)
+    self.simple_acts_as_list_scope[index + 1]
+  end
+
+  # Returns previous list item
+  #
+  # Returns +nil+ if the item is the first one of the list
+  def previous_item
+    index = self.simple_acts_as_list_scope.index(self)
+    index == 0 ? nil : self.simple_acts_as_list_scope[index - 1]
+  end
+
+  # Returns the item with +offset+ position based on current item
+  #
+  # Example:
+  #   @todo = Todo.create
+  #   @todo_2 = Todo.create
+  #   @todo.item_at_offset(1) # returns @todo_2
+  #   @todo_2.item_at_offset(-1) # returns @todo
+  #
+  def item_at_offset(offset)
+    item_index = self.simple_acts_as_list_scope.index(self)
+    index = item_index + offset
+    index < 0 ? nil : self.simple_acts_as_list_scope[index]
+  end
+
+  protected
+
+  # Updates item's position that is being created
+  def update_position
+    if self.simple_acts_as_list_scope.length == 0
+      self.position = 1
+    else
+      self.position = self.simple_acts_as_list_scope.last.position + 1
+    end
+  end
+
+  # Auxiliar method to invoke the scope that returns the list
+  def simple_acts_as_list_scope
+    scope_id = self.send(self.class.simple_acts_as_list_scope_id)
+    self.class.simple_acts_as_list_scope(scope_id)
+  end
+end

data/lib/simple_acts_as_list/version.rb

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

data/simple_acts_as_list.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_acts_as_list/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "simple_acts_as_list"
+  gem.version       = SimpleActsAsList::VERSION
+  gem.authors       = ["Juliana Lucena"]
+  gem.email         = ["julianalucenaa@gmail.com"]
+  gem.description   = %q{Provides a very simple list behavior based on a scope.}
+  gem.summary       = %q{Provides a very simple list behavior based on a scope.}
+  gem.homepage      = "https://github.com/redu/simple_acts_as_list"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'activesupport'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'activerecord'
+end

data/spec/model_additions_spec.rb

@@ -0,0 +1,162 @@
+require 'spec_helper'
+
+describe SimpleActsAsList::ModelAdditions do
+  context ".create" do
+    context "without position" do
+      context "and the list is empty" do
+        let(:todo_list) { create_todo_list(:qtt_items => 0) }
+        let(:item) do
+          Item.create(:name => "Item", :todo_list => todo_list)
+        end
+
+        it "should set the position to 1" do
+          item.reload
+          item.position.should_not be_nil
+          item.position.should == 1
+        end
+      end
+
+      context "and the list is not empty" do
+        let(:todo_list) do
+          create_todo_list(:qtt_items => 3)
+        end
+        let(:item) do
+          Item.create(:name => "Item", :todo_list => todo_list)
+        end
+
+        it "should set the position to 4" do
+          item.reload
+          item.position.should_not be_nil
+          item.position.should == 4
+        end
+      end
+    end
+  end
+
+
+  context "list methods" do
+    let(:todo_list) { create_todo_list(:qtt_items => 3) }
+
+    context "responders" do
+      let(:item) { Item.new(:name => "Item") }
+
+      [:position, :last_item?, :first_item?, :last_item, :first_item,
+       :next_item, :previous_item].each do |method|
+        it "should respond to #{method}"  do
+          item.should respond_to(method)
+        end
+       end
+    end
+
+    context "#last_item?" do
+      it "should return true when the item is the last" do
+        last = todo_list.items.last
+        last.should be_last_item
+      end
+
+      it "should return false when the item is not the last" do
+        first = todo_list.items.first
+        first.should_not be_last_item
+
+        middle = todo_list.items[1]
+        middle.should_not be_last_item
+      end
+    end
+
+    context "#first_item?" do
+      it "should return true when the item is the first" do
+        first = todo_list.items.first
+        first.should be_first_item
+      end
+
+      it "should return false when the item is not the first" do
+        last = todo_list.items.last
+        last.should_not be_first_item
+
+        middle = todo_list.items[1]
+        middle.should_not be_first_item
+      end
+    end
+
+    context "#last_item" do
+      it "should return the last item of the list" do
+        item = todo_list.items.first
+        item.last_item.should == todo_list.items.last
+      end
+    end
+
+    context "#first_item" do
+      it "should return the first item of the list" do
+        item = todo_list.items.last
+        item.first_item.should == todo_list.items.first
+      end
+    end
+
+    context "#next_item" do
+      it "should return the next item of the list" do
+        first = todo_list.items.first
+        first.next_item.should == todo_list.items[1]
+
+        item = todo_list.items[1]
+        item.next_item.should == todo_list.items[2]
+      end
+
+      it "should return nil if it is the last item of the list" do
+        last = todo_list.items.last
+        last.next_item.should be_nil
+      end
+    end
+
+    context "#previous_item" do
+      it "should return the previous item of the list" do
+        last = todo_list.items.last
+        length = todo_list.items.length
+        last.previous_item.should == todo_list.items[length - 2]
+
+        item = todo_list.items[1]
+        item.previous_item.should == todo_list.items[0]
+      end
+
+      it "should return nil if it is the first item of the list" do
+        first = todo_list.items.first
+        first.previous_item.should be_nil
+      end
+    end
+
+    context "#item_at_offset" do
+      it "should return the item with specified negative offset" do
+        item = todo_list.items.last
+        length = todo_list.items.length
+        item.item_at_offset(-2).should ==
+          todo_list.items[length - 3]
+      end
+
+      it "should return the item with specified positive offset" do
+        item = todo_list.items.first
+        length = todo_list.items.length
+        item.item_at_offset(2).should ==
+          todo_list.items[2]
+      end
+
+      it "should return nil if can't find the item with neg specified offset" do
+        item = todo_list.items.first
+        item.item_at_offset(-1).should be_nil
+      end
+
+      it "should return nil if can't find the item with pos specified offset" do
+        item = todo_list.items.last
+        item.item_at_offset(2).should be_nil
+      end
+    end
+  end
+
+  private
+
+  def create_todo_list(opts={})
+    qtt_items = opts[:qtt_items] || 1
+
+    todo_list = TodoList.create(:name => "My Todo List")
+    (1..qtt_items).each {|i| todo_list.items << Item.new(:name => "Item #{i}") }
+    todo_list
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+#
+require 'simple_acts_as_list'
+require 'support/setup_ar_and_schema'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/setup_ar_and_schema.rb

@@ -0,0 +1,27 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3',
+                                        :database => ':memory:')
+
+ActiveRecord::Schema.define do
+  create_table 'todo_lists', :force => true do |t|
+    t.string 'name'
+  end
+
+  create_table 'items', :force => true do |t|
+    t.string 'name'
+    t.integer 'todo_list_id'
+    t.integer 'position'
+  end
+end
+
+class TodoList < ActiveRecord::Base
+  has_many :items
+end
+
+class Item < ActiveRecord::Base
+  include SimpleActsAsList::ModelAdditions
+  simple_acts_as_list :scope => :todo_list_id
+
+  belongs_to :todo_list
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: simple_acts_as_list
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Juliana Lucena
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: 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: 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: 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'
+description: Provides a very simple list behavior based on a scope.
+email:
+- julianalucenaa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_acts_as_list.rb
+- lib/simple_acts_as_list/model_additions.rb
+- lib/simple_acts_as_list/version.rb
+- simple_acts_as_list.gemspec
+- spec/model_additions_spec.rb
+- spec/spec_helper.rb
+- spec/support/setup_ar_and_schema.rb
+homepage: https://github.com/redu/simple_acts_as_list
+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.24
+signing_key: 
+specification_version: 3
+summary: Provides a very simple list behavior based on a scope.
+test_files:
+- spec/model_additions_spec.rb
+- spec/spec_helper.rb
+- spec/support/setup_ar_and_schema.rb