key_mapable 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.travis.yml +5 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +35 -0
- data/LICENSE.txt +21 -0
- data/README.md +61 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/key_mapable.gemspec +35 -0
- data/lib/key_mapable.rb +42 -0
- data/lib/key_mapable/mapper.rb +46 -0
- data/lib/key_mapable/version.rb +3 -0
- metadata +101 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 04faca4917e7b3ad32a2714d2c2e1efdf4572accc1d0cf8668514fbb93e91e84
|
4
|
+
data.tar.gz: 85dbcebfcf053aa9cae04a9c0f8d0616cd1ed9985c108af4ddf93db9ac25f493
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: a7f232c795d1e8c1dd6e00c2f591166796b3efde87c43d71f24bcb87d0251a5ee8502048f37b57138ea8059ae48cfdd5a29f4bd064531642837a44fdfb48239a
|
7
|
+
data.tar.gz: 03114cb42d6193b74aa80ddb965134c90d5dcf8dde35602a174a325484cceee6d9cbfae0c102d776479cecb7266990f23f012ff3eb9236a4dd1a50b360420468
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
key_mapable (0.1.0)
|
5
|
+
|
6
|
+
GEM
|
7
|
+
remote: https://rubygems.org/
|
8
|
+
specs:
|
9
|
+
diff-lcs (1.3)
|
10
|
+
rake (10.5.0)
|
11
|
+
rspec (3.8.0)
|
12
|
+
rspec-core (~> 3.8.0)
|
13
|
+
rspec-expectations (~> 3.8.0)
|
14
|
+
rspec-mocks (~> 3.8.0)
|
15
|
+
rspec-core (3.8.0)
|
16
|
+
rspec-support (~> 3.8.0)
|
17
|
+
rspec-expectations (3.8.2)
|
18
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
19
|
+
rspec-support (~> 3.8.0)
|
20
|
+
rspec-mocks (3.8.0)
|
21
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
22
|
+
rspec-support (~> 3.8.0)
|
23
|
+
rspec-support (3.8.0)
|
24
|
+
|
25
|
+
PLATFORMS
|
26
|
+
ruby
|
27
|
+
|
28
|
+
DEPENDENCIES
|
29
|
+
bundler (~> 1.16)
|
30
|
+
key_mapable!
|
31
|
+
rake (~> 10.0)
|
32
|
+
rspec (~> 3.0)
|
33
|
+
|
34
|
+
BUNDLED WITH
|
35
|
+
1.16.0
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2019 Emric
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,61 @@
|
|
1
|
+
# KeyMapable
|
2
|
+
|
3
|
+
Easily transform keys from one format to another.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'key_mapable'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install key_mapable
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
class MyClass
|
25
|
+
extend KeyMapable
|
26
|
+
|
27
|
+
# Define a method called `#to_h` that use the provided map. The keys
|
28
|
+
# will be accessed on the provided subject.
|
29
|
+
define_map(:to_h, subject: :my_reader) do
|
30
|
+
# Map the value of `#name` to the key 'Name'.
|
31
|
+
key_map(:name, 'Name')
|
32
|
+
|
33
|
+
# Map the value of `#maybe_value` to the key 'GuaranteedValue'.
|
34
|
+
# Transform the value by calling `#to_s` first.
|
35
|
+
key_map(:maybe_value, 'GuaranteedValue', &:to_s)
|
36
|
+
|
37
|
+
# Map the key 'Name' to the value provided by the block.
|
38
|
+
key_value('AConstant') { 'Foo' }
|
39
|
+
|
40
|
+
# Map every item returned from `#rows`.
|
41
|
+
array_key_map(:rows, 'Rows') do
|
42
|
+
# Map the value of `#id` to the key 'Id'.
|
43
|
+
key_map(:id, 'Id')
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
## Development
|
50
|
+
|
51
|
+
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.
|
52
|
+
|
53
|
+
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).
|
54
|
+
|
55
|
+
## Contributing
|
56
|
+
|
57
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/key_mapable.
|
58
|
+
|
59
|
+
## License
|
60
|
+
|
61
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "key_mapable"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
data/key_mapable.gemspec
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
|
2
|
+
lib = File.expand_path("../lib", __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require "key_mapable/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "key_mapable"
|
8
|
+
spec.version = KeyMapable::VERSION
|
9
|
+
spec.authors = ["Emric"]
|
10
|
+
spec.email = ["emric.mansson@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = "Easily transform keys from one format to another."
|
13
|
+
spec.homepage = "https://github.com/istanful/key_mapable"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
|
17
|
+
# to allow pushing to a single host or delete this section to allow pushing to any host.
|
18
|
+
if spec.respond_to?(:metadata)
|
19
|
+
spec.metadata["allowed_push_host"] = "https://rubygems.org"
|
20
|
+
else
|
21
|
+
raise "RubyGems 2.0 or newer is required to protect against " \
|
22
|
+
"public gem pushes."
|
23
|
+
end
|
24
|
+
|
25
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
26
|
+
f.match(%r{^(test|spec|features)/})
|
27
|
+
end
|
28
|
+
spec.bindir = "exe"
|
29
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
30
|
+
spec.require_paths = ["lib"]
|
31
|
+
|
32
|
+
spec.add_development_dependency "bundler", "~> 1.16"
|
33
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
34
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
35
|
+
end
|
data/lib/key_mapable.rb
ADDED
@@ -0,0 +1,42 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "key_mapable/version"
|
4
|
+
require "key_mapable/mapper"
|
5
|
+
|
6
|
+
# Used to map the instance of the extended class to a new format.
|
7
|
+
#
|
8
|
+
# Usage:
|
9
|
+
#
|
10
|
+
# class MyClass
|
11
|
+
# extend KeyMapable
|
12
|
+
#
|
13
|
+
# # Define a method called `#to_h` that use the provided map. The keys
|
14
|
+
# # will be accessed on the provided subject.
|
15
|
+
# define_map(:to_h, subject: :my_reader) do
|
16
|
+
# # Map the value of `#name` to the key 'Name'.
|
17
|
+
# key_map(:name, 'Name')
|
18
|
+
#
|
19
|
+
# # Map the value of `#maybe_value` to the key 'GuaranteedValue'.
|
20
|
+
# # Transform the value by calling `#to_s` first.
|
21
|
+
# key_map(:maybe_value, 'GuaranteedValue', &:to_s)
|
22
|
+
#
|
23
|
+
# # Map the key 'Name' to the value provided by the block.
|
24
|
+
# key_value('AConstant') { 'Foo' }
|
25
|
+
#
|
26
|
+
# # Map every item returned from `#rows`.
|
27
|
+
# array_key_map(:rows, 'Rows') do
|
28
|
+
# # Map the value of `#id` to the key 'Id'.
|
29
|
+
# key_map(:id, 'Id')
|
30
|
+
# end
|
31
|
+
# end
|
32
|
+
# end
|
33
|
+
module KeyMapable
|
34
|
+
def define_map(method_name, subject: :self, &block)
|
35
|
+
define_method(method_name) do
|
36
|
+
value = public_send(subject)
|
37
|
+
mapper = Mapper.new(value)
|
38
|
+
mapper.instance_eval(&block)
|
39
|
+
mapper.resolve
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
@@ -0,0 +1,46 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Used internally by the KeyMapable concern.
|
4
|
+
class KeyMapable::Mapper
|
5
|
+
attr_reader :value
|
6
|
+
|
7
|
+
def initialize(value)
|
8
|
+
@value = value
|
9
|
+
@tree = {}
|
10
|
+
end
|
11
|
+
|
12
|
+
def key(name, &block)
|
13
|
+
child_mapper = self.class.new(value)
|
14
|
+
child_mapper.instance_eval(&block)
|
15
|
+
@tree[name] = child_mapper.resolve
|
16
|
+
end
|
17
|
+
|
18
|
+
def key_map(original_key, new_key, &block)
|
19
|
+
original_value = value.public_send(original_key)
|
20
|
+
if block_given?
|
21
|
+
child_mapper = self.class.new(original_value)
|
22
|
+
@tree[new_key] = child_mapper.instance_eval do
|
23
|
+
yield(original_value)
|
24
|
+
end
|
25
|
+
else
|
26
|
+
@tree[new_key] = original_value
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
def key_value(key)
|
31
|
+
@tree[key] = yield()
|
32
|
+
end
|
33
|
+
|
34
|
+
def array_key_map(original_key, new_key, &block)
|
35
|
+
original_value = value.public_send(original_key)
|
36
|
+
@tree[new_key] = original_value.map do |item|
|
37
|
+
child_mapper = self.class.new(item)
|
38
|
+
child_mapper.instance_eval(&block)
|
39
|
+
child_mapper.resolve
|
40
|
+
end
|
41
|
+
end
|
42
|
+
|
43
|
+
def resolve
|
44
|
+
@tree
|
45
|
+
end
|
46
|
+
end
|
metadata
ADDED
@@ -0,0 +1,101 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: key_mapable
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Emric
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2019-01-16 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.16'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.16'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
description:
|
56
|
+
email:
|
57
|
+
- emric.mansson@gmail.com
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- ".gitignore"
|
63
|
+
- ".rspec"
|
64
|
+
- ".travis.yml"
|
65
|
+
- Gemfile
|
66
|
+
- Gemfile.lock
|
67
|
+
- LICENSE.txt
|
68
|
+
- README.md
|
69
|
+
- Rakefile
|
70
|
+
- bin/console
|
71
|
+
- bin/setup
|
72
|
+
- key_mapable.gemspec
|
73
|
+
- lib/key_mapable.rb
|
74
|
+
- lib/key_mapable/mapper.rb
|
75
|
+
- lib/key_mapable/version.rb
|
76
|
+
homepage: https://github.com/istanful/key_mapable
|
77
|
+
licenses:
|
78
|
+
- MIT
|
79
|
+
metadata:
|
80
|
+
allowed_push_host: https://rubygems.org
|
81
|
+
post_install_message:
|
82
|
+
rdoc_options: []
|
83
|
+
require_paths:
|
84
|
+
- lib
|
85
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
91
|
+
requirements:
|
92
|
+
- - ">="
|
93
|
+
- !ruby/object:Gem::Version
|
94
|
+
version: '0'
|
95
|
+
requirements: []
|
96
|
+
rubyforge_project:
|
97
|
+
rubygems_version: 2.7.3
|
98
|
+
signing_key:
|
99
|
+
specification_version: 4
|
100
|
+
summary: Easily transform keys from one format to another.
|
101
|
+
test_files: []
|