transformable_list 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51a39008794e6d074cf21deb567f777663d72429
+  data.tar.gz: e687fdaf48e930ec04ab0f374430460f664c5dba
+SHA512:
+  metadata.gz: 73338b5e34c7f3d3bfae212a63b76b1da7407478f3ee26bf3f5488b182125867af6a4af292fa4f1afe6cc92a14ab698ebfc908f710314cb30cc7e386028c870a
+  data.tar.gz: b8ec4bb0ddfb86123c48b66c67a57bda797a1b991750dc63ad5bc49c97a9b9b48663bed6736d511603b99e80c989dcf750a17ff7883073dcb038468fc7fabb13

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.2
+before_install: gem install bundler -v 1.13.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at max@crossfield.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Maxim Chernyak
+
+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,85 @@
+# TransformableList
+
+Need to transform one list into another without wreaking too much havoc? Just follow the steps.
+
+```
+>> TransformableList.new(%w(c a x b)).transform(%w(a b c d e))
+=> [
+     [:delete, "x", 2],
+     [:create, "d", 3],
+     [:create, "e", 4],
+     [:move, "a", 0],
+     [:move, "b", 1],
+     [:move, "c", 2]
+   ]
+```
+
+Each step is `[action, item, index]` where action can be
+
+- delete
+- create
+- move
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'transformable_list'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transformable_list
+
+## Matcher
+
+You can change what items are considered equal by supplying a matcher.
+
+```ruby
+Transformable.new(%(a foo), matcher: -> a, b { a.size == b.size })
+```
+
+The default is `-> a, b { a == b }`.
+
+## Use case
+
+A use case for this gem could be an ActiveRecord has_many association that maintains a sequential index field. Let's say you have a voting system, and a user would assign all the choices by assigning an array. When you are updating existing choices into new ones, you want to keep most of them intact. You can then use logic like this:
+
+```ruby
+original_list = TransformableList.new(choices, matcher: -> a, b { a['text'] == b['text'] })
+steps = original_list.transform(new_list)
+
+steps.each do |step|
+  action, item, index = step
+
+  case action
+  when :delete then item.destroy
+  when :create then choices.create(text: item['text'], index: index)
+  when :move then item.update_attribute(:index, index)
+  end
+end
+```
+
+## Algorithm efficiency
+
+The gem was not intended for big lists, and efficiency wasn't a concern. If you have ideas on how to make it more efficient, PRs are very welcome.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/crossfield/transformable_list. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "transformable_list"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/transformable_list.rb

@@ -0,0 +1,63 @@
+require 'transformable_list/version'
+require 'set'
+
+class TransformableList
+  def initialize(items, matcher: -> a, b { a == b })
+    @items = items
+    @matcher = matcher
+  end
+
+  def transform(new_items)
+    build_remaining_items_index!
+
+    moves = []
+    creates = []
+    deletes = []
+
+    indexes_to_keep = Set.new
+
+    new_items.map.with_index do |new_item, new_index|
+      if existing_index = find_index_and_eliminate_match(new_item)
+        if new_index != existing_index
+          moves << [:move, @items[existing_index], new_index]
+        end
+
+        indexes_to_keep << existing_index
+      else
+        creates << [:create, new_item, new_index]
+      end
+    end
+
+    (0...@items.size).each do |index|
+      unless indexes_to_keep.include?(index)
+        deletes << [:delete, @items[index], index]
+      end
+    end
+
+    deletes.sort_by(&:last) + creates.sort_by(&:last) + moves.sort_by(&:last)
+  end
+
+  private
+
+  def build_remaining_items_index!
+    @remaining_items = @items.map.with_index{|item, i| [item, i]}
+  end
+
+  def find_index_and_eliminate_match(new_item)
+    remaining_index =
+      @remaining_items.index{|item, _| item.object_id == new_item.object_id} ||
+        @remaining_items.index{|item, _| match?(item, new_item)}
+
+    _, original_index = if remaining_index
+      result = @remaining_items[remaining_index]
+      @remaining_items.delete_at(remaining_index)
+      result
+    end
+
+    original_index
+  end
+
+  def match?(a, b)
+    @matcher.(a, b)
+  end
+end

data/lib/transformable_list/version.rb

@@ -0,0 +1,3 @@
+class TransformableList
+  VERSION = "0.1.0"
+end

data/transformable_list.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transformable_list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "transformable_list"
+  spec.version       = TransformableList::VERSION
+  spec.authors       = ["Maxim Chernyak"]
+  spec.email         = ["max@crossfield.com"]
+
+  spec.summary       = %q{Determine steps to transform a list into another list}
+  spec.description   = %q{Given 2 lists this gem would show steps necessary } +
+                       %q{to convert one to another.}
+  spec.homepage      = "https://github.com/crossfield/transformable_list"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: transformable_list
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maxim Chernyak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Given 2 lists this gem would show steps necessary to convert one to another.
+email:
+- max@crossfield.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/transformable_list.rb
+- lib/transformable_list/version.rb
+- transformable_list.gemspec
+homepage: https://github.com/crossfield/transformable_list
+licenses:
+- MIT
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Determine steps to transform a list into another list
+test_files: []