me_first 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f344df8032472b8574e58dbc953ad86ac53bd68a
+  data.tar.gz: 78dafc5eaa034b107ed24bb4d8d934426773275b
+SHA512:
+  metadata.gz: cfff622205e1d6f77a2e0759aa44fad400e4f4e6f5cc855fd0cd35dee31224f3c0fb1c765bcfb61155be00be1b160d4137d0041e0974726173c0032e478714c0
+  data.tar.gz: 5a47b8179b4853bde27120a3bb54c1ad0307e0f2ecbcd11f60f61d6ce96c692d1c91cc9d3e6311c0d2f477b0deb810fdf121cff7cf937918b53bc943df24120a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,102 @@
+
+# MeFirst
+
+A straighforward extension for ActiveRecord models which makes it easy to reorder objects by a given column's values. 
+
+![lemon-line](http://dl.dropboxusercontent.com/s/kuwpzbcz5659umh/lemon-line.gif?dl=0)
+
+## Getting Started
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'me_first'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install me_first
+
+## Usage
+
+### Installation
+
+To use MeFirst, you need to:
+
+1. Add an `integer` ordering column to your model.
+2. Require MeFirst in your model.
+3. Use MeFirst's `attr_orderable` method with the ordering column as an argument. 
+
+So:
+
+```bash
+$ rails g migration add_column_order_to_fake_models order:integer
+$ rake db:migrate
+```
+
+```ruby
+class FakeModel
+    include MeFirst
+    attr_orderable :order
+end
+```
+
+That's it! You're now ready to reorder by `order` (or whichever column name you want) at will.
+
+
+### Commands
+
+MeFirst gives you a number of commands, named based on the given column. For the above example, you're given two scopes:
+
+```ruby
+FakeModel.by_order
+FakeModel.by_reverse_order
+```
+
+And a number of useful instance methods:
+
+```ruby
+instance = FakeModel.first
+instance.move_order_up!(2) # Moves the instance's order up by 2 places
+instance.move_order_down!(1) # Moves the instance's order down by 1 place
+instance.move_order_to_end!
+instance.move_order_to_beginning!
+instance.set_order!(5) # Sets the current instance's order to 5, and reorders other instances around it.
+```
+
+> To get a clearer sense of what exactly these methods do, check out [the specs](https://github.com/sashafklein/me_first/tree/master/spec/me_first_spec.rb).
+
+Note that these methods are all dependent upon the column name:
+
+```ruby
+class FakeModel
+    include MeFirst
+    attr_orderable :position
+end
+
+FakeModel.by_position
+FakeModel.first.move_position_up!(5)
+```
+
+
+### Performance Note
+
+This works great for relatively small numbers of objects. When dealing with a large table of ordered objects, MeFirst (and ordering by column in general), will not be particularly performant -- resetting a single instance's order requires changing the order of all the objects which followed its initial location. 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/sashafklein/me_first/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "me_first"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/me_first.rb

@@ -0,0 +1,76 @@
+require 'me_first/version'
+
+module MeFirst
+
+  module ClassMethods
+
+    def attr_orderable(*attrs)
+      attrs.each do |att|
+
+        metaclass.instance_eval do 
+          define_method "by_#{att}" do
+            self.order(att => :asc)
+          end
+
+          define_method "by_reverse_#{att}" do
+            self.order(att => :desc)
+          end
+        end
+
+        class_eval do 
+          define_method "move_#{att}_to_end!" do
+            others = self.class.send("by_#{att}").where.not(id: self.id).to_a
+            
+            save_to_db( others.concat([self]), att)
+          end
+
+          define_method "set_#{att}!" do |new_order|
+            new_order = 0 if new_order < 0
+            
+            others = self.class.send("by_#{att}").where.not(id: self.id).to_a
+
+            if new_order > others.length + 1
+              self.send("move_#{att}_to_end!")
+            else
+              others.insert( new_order, self )
+
+              save_to_db( others, att )
+            end
+          end
+
+          define_method "move_#{att}_to_beginning!" do 
+            send("set_#{att}!", 0)
+          end
+
+          define_method "move_#{att}_up!" do |num=1|
+            send("set_#{att}!", self.order + num)
+          end
+
+          define_method "move_#{att}_down!" do |num=1|
+            send("set_#{att}!", self.order - num)
+          end
+
+          define_method "save_to_db" do |items, att|
+            ActiveRecord::Base.transaction do 
+              items.compact.each_with_index do |item, index|
+                item.send( "#{att}=", index )
+                item.save!
+              end
+            end
+          end
+
+          private :save_to_db
+        end
+
+      end
+    end
+
+    def metaclass
+      class << self; self; end
+    end
+  end
+  
+  def self.included(base)
+    base.extend ClassMethods
+  end
+end

data/lib/me_first/version.rb

@@ -0,0 +1,3 @@
+module MeFirst
+  VERSION = "0.1.1"
+end

data/me_first.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'me_first/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "me_first"
+  spec.version       = MeFirst::VERSION
+  spec.authors       = ["Sasha Klein"]
+  spec.email         = ["sashafklein@gmail.com"]
+
+  spec.summary       = %q{A tool to centralize and simplify ActiveRecord reordering.}
+  spec.homepage      = "https://www.github.com/sashafklein/me_first"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "binding_of_caller"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: me_first
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sasha Klein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- sashafklein@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/me_first.rb
+- lib/me_first/version.rb
+- me_first.gemspec
+homepage: https://www.github.com/sashafklein/me_first
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A tool to centralize and simplify ActiveRecord reordering.
+test_files: []