key_mapable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04faca4917e7b3ad32a2714d2c2e1efdf4572accc1d0cf8668514fbb93e91e84
+  data.tar.gz: 85dbcebfcf053aa9cae04a9c0f8d0616cd1ed9985c108af4ddf93db9ac25f493
+SHA512:
+  metadata.gz: a7f232c795d1e8c1dd6e00c2f591166796b3efde87c43d71f24bcb87d0251a5ee8502048f37b57138ea8059ae48cfdd5a29f4bd064531642837a44fdfb48239a
+  data.tar.gz: 03114cb42d6193b74aa80ddb965134c90d5dcf8dde35602a174a325484cceee6d9cbfae0c102d776479cecb7266990f23f012ff3eb9236a4dd1a50b360420468

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in key_mapable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    key_mapable (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  key_mapable!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Emric
+
+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,61 @@
+# KeyMapable
+
+Easily transform keys from one format to another.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'key_mapable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install key_mapable
+
+## Usage
+
+```ruby
+class MyClass
+  extend KeyMapable
+
+  # Define a method called `#to_h` that use the provided map. The keys
+  # will be accessed on the provided subject.
+  define_map(:to_h, subject: :my_reader) do
+    # Map the value of `#name` to the key 'Name'.
+    key_map(:name, 'Name')
+
+    # Map the value of `#maybe_value` to the key 'GuaranteedValue'.
+    # Transform the value by calling `#to_s` first.
+    key_map(:maybe_value, 'GuaranteedValue', &:to_s)
+
+    # Map the key 'Name' to the value provided by the block.
+    key_value('AConstant') { 'Foo' }
+
+    # Map every item returned from `#rows`.
+    array_key_map(:rows, 'Rows') do
+      # Map the value of `#id` to the key 'Id'.
+      key_map(:id, 'Id')
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/key_mapable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "key_mapable"
+
+# 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(__FILE__)

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/key_mapable.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "key_mapable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "key_mapable"
+  spec.version       = KeyMapable::VERSION
+  spec.authors       = ["Emric"]
+  spec.email         = ["emric.mansson@gmail.com"]
+
+  spec.summary       = "Easily transform keys from one format to another."
+  spec.homepage      = "https://github.com/istanful/key_mapable"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/key_mapable.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "key_mapable/version"
+require "key_mapable/mapper"
+
+# Used to map the instance of the extended class to a new format.
+#
+# Usage:
+#
+#   class MyClass
+#     extend KeyMapable
+#
+#     # Define a method called `#to_h` that use the provided map. The keys
+#     # will be accessed on the provided subject.
+#     define_map(:to_h, subject: :my_reader) do
+#       # Map the value of `#name` to the key 'Name'.
+#       key_map(:name, 'Name')
+#
+#       # Map the value of `#maybe_value` to the key 'GuaranteedValue'.
+#       # Transform the value by calling `#to_s` first.
+#       key_map(:maybe_value, 'GuaranteedValue', &:to_s)
+#
+#       # Map the key 'Name' to the value provided by the block.
+#       key_value('AConstant') { 'Foo' }
+#
+#       # Map every item returned from `#rows`.
+#       array_key_map(:rows, 'Rows') do
+#         # Map the value of `#id` to the key 'Id'.
+#         key_map(:id, 'Id')
+#       end
+#     end
+#   end
+module KeyMapable
+  def define_map(method_name, subject: :self, &block)
+    define_method(method_name) do
+      value = public_send(subject)
+      mapper = Mapper.new(value)
+      mapper.instance_eval(&block)
+      mapper.resolve
+    end
+  end
+end

data/lib/key_mapable/mapper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Used internally by the KeyMapable concern.
+class KeyMapable::Mapper
+  attr_reader :value
+
+  def initialize(value)
+    @value = value
+    @tree = {}
+  end
+
+  def key(name, &block)
+    child_mapper = self.class.new(value)
+    child_mapper.instance_eval(&block)
+    @tree[name] = child_mapper.resolve
+  end
+
+  def key_map(original_key, new_key, &block)
+    original_value = value.public_send(original_key)
+    if block_given?
+      child_mapper = self.class.new(original_value)
+      @tree[new_key] = child_mapper.instance_eval do
+        yield(original_value)
+      end
+    else
+      @tree[new_key] = original_value
+    end
+  end
+
+  def key_value(key)
+    @tree[key] = yield()
+  end
+
+  def array_key_map(original_key, new_key, &block)
+    original_value = value.public_send(original_key)
+    @tree[new_key] = original_value.map do |item|
+      child_mapper = self.class.new(item)
+      child_mapper.instance_eval(&block)
+      child_mapper.resolve
+    end
+  end
+
+  def resolve
+    @tree
+  end
+end

data/lib/key_mapable/version.rb

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

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: key_mapable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emric
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- emric.mansson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- key_mapable.gemspec
+- lib/key_mapable.rb
+- lib/key_mapable/mapper.rb
+- lib/key_mapable/version.rb
+homepage: https://github.com/istanful/key_mapable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Easily transform keys from one format to another.
+test_files: []