hash-migrations 0.0.1

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem "rake"
+  gem "rspec"
+  gem "guard"
+  gem "guard-bundler"
+  gem "guard-rspec"
+  gem "rb-fsevent"
+  gem "terminal-notifier-guard"
+end

data/Guardfile

@@ -0,0 +1,13 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec' do
+  watch(%r{^spec/unit/.+_spec\.rb$})
+  watch(%r{^spec/functional/.+_spec\.rb$})
+  watch(%r{^lib/hash/migrations/(.+)\.rb$})     { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch(%r{^lib/hash/migrations/(.+)\.rb$})     { |m| "spec/functional/hash_migrations_spec.rb" }
+  watch('lib/hash/migrations/core_ext.rb')      { 'spec' }
+  watch('spec/spec_helper.rb')                  { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Martin Englund
+
+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,54 @@
+# Hash Migrations
+
+Using a yaml file and then loading it into a hash, to store settings is a common pattern.
+Over time the settings usually change, which will cause the code to contain checks for which version of the settings is used.
+
+This gem introduces migrations for hashes so you can keep the code simple and maintain changes to the hash in separate migration files.
+
+It can be used in two ways, either it returns a new hash:
+
+    migrated_hash = Hash::Migrator.run(hash, dir, options)
+
+
+Or it can modify the existing hash, if you call the instance method.
+
+    hash.migrate(dir, options)
+
+
+A sample hash migration looks like this, and the file should be named `YYYYMMDDHHmmss_description.rb`
+
+    Hash.migration do
+      up do |hash|
+        hash[:foo] = hash['foo']
+        hash.delete('foo')
+      end
+
+      down do
+        hash['foo'] = hash[:foo]
+        hash.delete(:foo)
+      end
+    end
+
+The migration assumes you have a top-level hash key named `:schema_version` (initialized to `0` if not present) which is used to track the migrations needed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hash-migrations'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash-migrations
+
+## 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

data/Rakefile

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

data/hash-migrations.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash/migrations/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "hash-migrations"
+  gem.version       = Hash::Migrations::VERSION
+  gem.authors       = ["Martin Englund"]
+  gem.email         = ["martin@englund.nu"]
+  gem.description   = %q{Migrations to manage hashes}
+  gem.summary       = %q{Migrations for hashes}
+  gem.homepage      = ""
+
+  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{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/hash/migrations.rb

@@ -0,0 +1,19 @@
+require 'hash/migrations/version'
+require 'hash/migrations/errors'
+require 'hash/migrations/migration'
+require 'hash/migrations/migrator'
+require 'hash/migrations/core_ext'
+
+module Hash::Migrations
+  # Apply migrations to a hash
+  # @param [Hash] hash hash to be migrated
+  # @param [String] dir path to the directory containing the migrations to apply
+  # @param [Hash] options options
+  # @return [Hash] migrated hash
+def run(hash, dir, options={direction: :up})
+    hash.dup.migrate(dir, options)
+  end
+
+  module_function :run
+end
+

data/lib/hash/migrations/core_ext.rb

@@ -0,0 +1,28 @@
+module Hash::Migrations::InstanceMethods
+  # Apply migrations to the hash
+  # @param [String] dir path to the directory containing the migrations to apply
+  # @param [Hash] options options
+  def migrate(dir, options={})
+    @direction = options.fetch(:direction, :up)
+    Hash::Migrations::Migrator.new(dir).run(self, options)
+  end
+
+  def up(&block)
+    yield self if @direction == :up
+  end
+
+  def down(&block)
+    yield self if @direction == :down
+  end
+end
+
+module Hash::Migrations::ClassMethods
+  def migration(&block)
+    block.call
+  end
+end
+
+class Hash
+  include Hash::Migrations::InstanceMethods
+  extend Hash::Migrations::ClassMethods
+end

data/lib/hash/migrations/errors.rb

@@ -0,0 +1,4 @@
+module Hash::Migrations
+  class MigrationFailed < StandardError; end
+  class VersionError < StandardError; end
+end

data/lib/hash/migrations/migration.rb

@@ -0,0 +1,33 @@
+module Hash::Migrations
+  class Migration
+    attr_reader :migration, :version
+
+    VERSION_REGEXP = %r{/(\d+)_.+}.freeze
+
+    def to_str
+      migration
+    end
+
+    def load(path)
+      @path = path
+
+      unless File.exists?(@path)
+        raise ArgumentError, "unable to load migration '#@path'"
+      end
+
+      @version = version_from_path
+      @migration = File.new(@path).read
+    end
+
+    private
+
+    def version_from_path
+      match = @path.match(VERSION_REGEXP)
+      unless match
+        raise VersionError, "unable to extract version from '#@path'"
+      end
+      match[1].to_i
+    end
+
+  end
+end

data/lib/hash/migrations/migrator.rb

@@ -0,0 +1,52 @@
+module Hash::Migrations
+  class Migrator
+    # @return [Array[Hash::Migrations::Migration]] the list of migrations in this migration
+    attr_reader :migrations
+
+    def initialize(migrations_dir=nil)
+      @migrations = []
+
+      return unless migrations_dir
+
+      unless Dir.exists?(migrations_dir)
+        raise ArgumentError, "#{migrations_dir} is not a directory"
+      end
+
+      Dir.entries(migrations_dir).each do |entry|
+        unless entry.match(/^\.+$/)
+          path = File.join(migrations_dir, entry)
+          migration = Hash::Migrations::Migration.new
+          migration.load(path)
+          add(migration)
+        end
+      end
+    end
+
+    def add(migration)
+      @migrations << migration
+    end
+
+    # @param [Hash] hash hash to be migrated
+    # @param [Hash] options options
+    # @return [Hash] migrated hash
+    def run(hash, options={})
+      # TODO raise error on existing version format?
+      # TODO only migrate to a certain version
+      schema_version = options.fetch(:schema_version, :schema_version)
+      version = hash[schema_version] || 0
+
+      migrations.each do |migration|
+        if version < migration.version
+          hash.instance_eval migration
+          version = migration.version
+          hash[schema_version] = version
+        end
+      end
+
+      hash
+    rescue => e
+      # TODO better error message?
+      raise Hash::Migrations::MigrationFailed.new(e)
+    end
+  end
+end

data/lib/hash/migrations/version.rb

@@ -0,0 +1,3 @@
+module Hash::Migrations
+  VERSION = "0.0.1"
+end

data/spec/assets/error/20130318164134_error.rb

@@ -0,0 +1 @@
+foobar

data/spec/assets/fail/fail.rb

@@ -0,0 +1,5 @@
+Hash.migration do
+  up do |hash|
+    hash[:foo] = Array(hash[:foo][:bar])
+  end
+end

data/spec/assets/migrations/20130317115503_initial.rb

@@ -0,0 +1,22 @@
+Hash.migration do
+
+# turn keys which are strings into symbols
+  up do |hash|
+    hash.keys.each do |key|
+      if key.is_a?(String)
+        hash[key.to_sym] = hash[key]
+        hash.delete(key)
+      end
+    end
+  end
+
+# turn keys which are symbols into strings
+  down do |hash|
+    hash.keys.each do |key|
+      if key.is_a?(Symbol)
+        hash[key.to_s] = hash[key]
+        hash.delete(key)
+      end
+    end
+  end
+end

data/spec/assets/migrations/20130317115507_second.rb

@@ -0,0 +1,9 @@
+Hash.migration do
+  up do |hash|
+    hash[:foo] = Array(hash[:foo])
+  end
+
+  down do |hash|
+    hash[:foo] = hash[:foo].first
+  end
+end

data/spec/assets/migrations/20130317115514_third.rb

@@ -0,0 +1,5 @@
+Hash.migration do
+  up do |hash|
+    hash[:bar] = 'foobar'
+  end
+end

data/spec/functional/hash_migrations_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Hash::Migrations do
+
+  context 'on hash' do
+    it 'should change self' do
+      hash = {:foo => 'bar'}
+
+      hash.migrate(asset('migrations'))
+
+      hash[:foo].should == %w[bar]
+    end
+
+    it 'should run all migrations in the directory' do
+      hash = {'foo' => 'bar'}
+
+      hash.migrate(asset('migrations'))
+
+      hash[:foo].should == %w[bar]
+    end
+
+    it 'should support a different schema_version name' do
+      hash = {'foo' => 'bar'}
+
+      hash.migrate(asset('migrations'), schema_version: :version)
+
+      hash[:foo].should == %w[bar]
+      hash[:version].should == 20130317115514
+    end
+
+    it 'should skip migrations less than the version' do
+      hash = {schema_version: 20130317115504, foo: 'bar'}
+
+      hash.migrate(asset('migrations'))
+
+      hash[:schema_version].should == 20130317115514
+      hash[:foo].should == %w[bar]
+      hash[:bar].should == 'foobar'
+    end
+
+    it 'should raise an error if a migration fails' do
+      expect {
+        {}.migrate(asset('error'))
+      }.to raise_error Hash::Migrations::MigrationFailed
+    end
+  end
+
+  context 'on module' do
+    it 'should return a new hash' do
+      hash = {:foo => 'bar'}
+      dup = hash.dup
+
+      migrated_hash = Hash::Migrations.run(hash, asset('migrations'))
+
+      migrated_hash[:foo].should == %w[bar]
+      migrated_hash.should_not == hash
+      hash.should == dup
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'hash/migrations'
+
+def asset(file)
+  File.expand_path(File.join('..', 'assets', file), __FILE__)
+end
+
+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
+
+  config.order = 'random'
+end

data/spec/unit/migraton_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Hash::Migrations::Migration do
+  let(:migration_file) { File.join(asset('error'), '20130318164134_error.rb') }
+  let(:migration) {
+    m = described_class.new
+    m.load(migration_file)
+    m
+  }
+
+  describe 'version' do
+    it 'should extract the version from the path' do
+      migration.version.should == 20130318164134
+    end
+
+    it 'should raise an error if it can not extract version from the path' do
+      incorrect_file = File.join(asset('fail'), 'fail.rb')
+      expect {
+        described_class.new.load(incorrect_file)
+      }.to raise_error Hash::Migrations::VersionError, %r[unable to extract version from '#{incorrect_file}']
+    end
+  end
+
+  describe 'migration' do
+    it 'should raise an exception when it can not load the migration' do
+      missing_file = File.join(asset('fail'), 'missing.rb')
+
+      expect {
+        described_class.new.load(missing_file)
+      }.to raise_error ArgumentError, %r[unable to load migration '#{missing_file}']
+    end
+
+    it 'should load migration from a path' do
+      migration.to_str.should == 'foobar'
+    end
+  end
+
+end

data/spec/unit/migrator_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Hash::Migrations::Migrator do
+  it 'should raise an error if the directory does not exist' do
+    expect {
+      described_class.new('/path/to/non/existing/directory')
+    }.to raise_error ArgumentError, '/path/to/non/existing/directory is not a directory'
+  end
+
+  it 'should skip the migration if the version is higher' do
+    migration = double(Hash::Migrations::Migration)
+    migration.stub(version: 20130318)
+
+    migrator = described_class.new
+    migrator.add(migration)
+
+    migrated_hash = migrator.run({})
+    migrated_hash[:schema_version].should == 20130318
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: hash-migrations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Martin Englund
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-14 00:00:00.000000000 Z
+dependencies: []
+description: Migrations to manage hashes
+email:
+- martin@englund.nu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hash-migrations.gemspec
+- lib/hash/migrations.rb
+- lib/hash/migrations/core_ext.rb
+- lib/hash/migrations/errors.rb
+- lib/hash/migrations/migration.rb
+- lib/hash/migrations/migrator.rb
+- lib/hash/migrations/version.rb
+- spec/assets/error/20130318164134_error.rb
+- spec/assets/fail/fail.rb
+- spec/assets/migrations/20130317115503_initial.rb
+- spec/assets/migrations/20130317115507_second.rb
+- spec/assets/migrations/20130317115514_third.rb
+- spec/functional/hash_migrations_spec.rb
+- spec/spec_helper.rb
+- spec/unit/migraton_spec.rb
+- spec/unit/migrator_spec.rb
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: -1303593863770819748
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1303593863770819748
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Migrations for hashes
+test_files:
+- spec/assets/error/20130318164134_error.rb
+- spec/assets/fail/fail.rb
+- spec/assets/migrations/20130317115503_initial.rb
+- spec/assets/migrations/20130317115507_second.rb
+- spec/assets/migrations/20130317115514_third.rb
+- spec/functional/hash_migrations_spec.rb
+- spec/spec_helper.rb
+- spec/unit/migraton_spec.rb
+- spec/unit/migrator_spec.rb