monolens 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: fded1da33ff2b2e68f5c0ec9177d77fed38d12576a7a505e7e50d25dd8c356c8
-  data.tar.gz: ebcc624d96c03a82b1939a9cd9d76c0902fd170510ca93a670b5fbf02e477f08
+SHA1:
+  metadata.gz: 704980b0a35ef47c4ea022a0b2bf39922966a11d
+  data.tar.gz: 0a032437e56dbd4d2214ba7b435120ceceb62709
 SHA512:
-  metadata.gz: 508ede1d192eb3cc5d5f9a359cb18f627e44b5cdbd4d9c89bc89c90b52787b96061efcd95a01a4855f7477213e33aa56a7178c9afe4ccf16124af9155d54af1d
-  data.tar.gz: 82138ad714e74d73c880eff43423d01546cfdf59569913d7d20734460dfc6ad08bab6ac7e4e8ae760a3a9de7884716297bd2433bd2a7c88f109d7fbc400b0fbd
+  metadata.gz: 2a580e3564f5bd208273e16c0c1da4c261917d371e0e6236bab873920b6a2372b7f36e5a085654f8f2ff79490f762cfeb68a8d38a24265d8cd4da5e983389f6e
+  data.tar.gz: '0229785824434dd14c87581f0060a784b623e3154b514bea8548d7cce94bb35563ceb6fdbc45146a883c4ca476c1c329b9adbd6a329ab1382f197377709170a6'

data/README.md

@@ -37,13 +37,13 @@ The following monolens file, say `lens.yml`
 ---
 version: 1.0
 lenses:
-- map:
-  - object.transform
+- array.map:
+  - object.transform:
       status:
       - str.upcase
       body:
       - str.strip
-  - object.rename
+  - object.rename:
       body: description
 ```
 
@@ -76,10 +76,11 @@ result = lens.call(input)
 ## Available lenses
 
 ```
-core.map          - Apply a lens to each member of an Array
 core.chain        - Applies a chain of lenses to an input value
+core.mapping      - Converts the input value via a key:value mapping
 
 str.strip         - Remove leading and trailing spaces of an input string
+str.split         - Splits the input string as an array
 str.downcase      - Converts the input string to lowercase
 str.upcase        - Converts the input string to uppercase
 
@@ -89,11 +90,14 @@ object.rename     - Rename some keys of the input object
 object.transform  - Applies specific lenses to specific values of the input object
 object.keys       - Applies a lens to all keys of the input object
 object.values     - Applies a lens to all values of the input object
+object.select     - Builds an object by selecting key/values from the input object
 
 coerce.date       - Coerces the input value to a date
 coerce.datetime   - Coerces the input value to a datetime
 
 array.compact     - Removes null from the input array
+array.join        - Joins values of the input array as a string
+array.map         - Apply a lens to each member of an Array
 ```
 
 ## Public API

data/lib/monolens/array/join.rb

@@ -0,0 +1,13 @@
+module Monolens
+  module Array
+    class Join
+      include Lens
+
+      def call(arg, *rest)
+        is_array!(arg)
+
+        arg.join(option(:separator, ' '))
+      end
+    end
+  end
+end

data/lib/monolens/{core → array}/map.rb

@@ -1,5 +1,5 @@
 module Monolens
-  module Core
+  module Array
     class Map
       include Lens
 

data/lib/monolens/array.rb

@@ -5,7 +5,19 @@ module Monolens
     end
     module_function :compact
 
+    def join(options = {})
+      Join.new(options)
+    end
+    module_function :join
+
+    def map(lens)
+      Map.new(lens)
+    end
+    module_function :map
+
     Monolens.define_namespace 'array', self
   end
 end
 require_relative 'array/compact'
+require_relative 'array/join'
+require_relative 'array/map'

data/lib/monolens/core/mapping.rb

@@ -0,0 +1,15 @@
+module Monolens
+  module Core
+    class Mapping
+      include Lens
+
+      def call(arg, *rest)
+        option(:values, {}).fetch(arg) do
+          raise LensError if option(:fail_if_missing)
+
+          option(:default)
+        end
+      end
+    end
+  end
+end

data/lib/monolens/core.rb

@@ -5,13 +5,13 @@ module Monolens
     end
     module_function :chain
 
-    def map(lens)
-      Map.new(lens)
+    def mapping(options)
+      Mapping.new(options)
     end
-    module_function :map
+    module_function :mapping
 
     Monolens.define_namespace 'core', self
   end
 end
 require_relative 'core/chain'
-require_relative 'core/map'
+require_relative 'core/mapping'

data/lib/monolens/lens.rb

@@ -12,11 +12,18 @@ module Monolens
         [ attr, arg[attr] ]
       elsif arg.key?(attr_s = attr.to_s)
         [ attr_s, arg[attr_s] ]
+      elsif arg.key?(attr_sym = attr.to_sym)
+        [ attr_sym, arg[attr_sym] ]
       else
         [ attr, nil ]
       end
     end
 
+    def option(name, default = nil)
+      _, option = fetch_on(name, options)
+      option.nil? ? default : option
+    end
+
     def is_string!(arg)
       return if arg.is_a?(::String)
 

data/lib/monolens/object/select.rb

@@ -0,0 +1,30 @@
+module Monolens
+  module Object
+    class Select
+      include Lens
+
+      def initialize(selection)
+        super({})
+        @selection = selection
+      end
+
+      def call(arg, *rest)
+        is_hash!(arg)
+
+        result = {}
+        @selection.each_pair do |new_attr, selector|
+          is_array = selector.is_a?(::Array)
+          is_symbol = false
+          values = Array(selector).map do |old_attr|
+            actual, fetched = fetch_on(old_attr, arg)
+            is_symbol ||= actual.is_a?(Symbol)
+            fetched
+          end
+          new_attr = is_symbol ? new_attr.to_sym : new_attr.to_s
+          result[new_attr] = is_array ? values : values.first
+        end
+        result
+      end
+    end
+  end
+end

data/lib/monolens/object.rb

@@ -20,6 +20,11 @@ module Monolens
     end
     module_function :values
 
+    def select(lens)
+      Select.new(lens)
+    end
+    module_function :select
+
     Monolens.define_namespace 'object', self
   end
 end
@@ -27,3 +32,4 @@ require_relative 'object/rename'
 require_relative 'object/transform'
 require_relative 'object/keys'
 require_relative 'object/values'
+require_relative 'object/select'

data/lib/monolens/str/split.rb

@@ -0,0 +1,14 @@
+module Monolens
+  module Str
+    class Split
+      include Lens
+
+      def call(arg, *rest)
+        is_string!(arg)
+
+        sep = option(:separator)
+        sep ? arg.split(sep) : arg.split
+      end
+    end
+  end
+end

data/lib/monolens/str.rb

@@ -1,23 +1,29 @@
 module Monolens
   module Str
+    def downcase(options = {})
+      Downcase.new(options)
+    end
+    module_function :downcase
+
     def strip(options = {})
       Strip.new(options)
     end
     module_function :strip
 
+    def split(options = {})
+      Split.new(options)
+    end
+    module_function :split
+
     def upcase(options = {})
       Upcase.new(options)
     end
     module_function :upcase
 
-    def downcase(options = {})
-      Downcase.new(options)
-    end
-    module_function :downcase
-
     Monolens.define_namespace 'str', self
   end
 end
+require_relative 'str/downcase'
 require_relative 'str/strip'
+require_relative 'str/split'
 require_relative 'str/upcase'
-require_relative 'str/downcase'

data/lib/monolens/version.rb

@@ -1,7 +1,7 @@
 module Monolens
   module Version
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"

data/lib/monolens.rb

@@ -24,7 +24,7 @@ module Monolens
     end
 
     def load_yaml(yaml)
-      Monolens::File.new(YAML.load(yaml))
+      Monolens::File.new(YAML.safe_load(yaml))
     end
 
     def lens(arg)

data/spec/monolens/array/test_compact.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Monolens, 'array.compact' do
+  subject do
+    Monolens.lens('array.compact')
+  end
+
+  it 'removes nils' do
+    expect(subject.call([nil, 'notnil'])).to eql(['notnil'])
+  end
+
+  it 'supports empty arrays' do
+    expect(subject.call([])).to eql([])
+  end
+end

data/spec/monolens/array/test_join.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Monolens, 'array.join' do
+  context 'when used without options' do
+    subject do
+      Monolens.lens('array.join')
+    end
+
+    it 'joins values with spaces' do
+      expect(subject.call(['hello', 'world'])).to eql('hello world')
+    end
+
+    it 'supports empty arrays' do
+      expect(subject.call([])).to eql('')
+    end
+  end
+
+  context 'when specifying the separator' do
+    subject do
+      Monolens.lens('array.join' => { separator: ', ' })
+    end
+
+    it 'joins values with it' do
+      expect(subject.call(['hello', 'world'])).to eql('hello, world')
+    end
+  end
+end

data/spec/monolens/array/test_map.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Monolens, 'array.map' do
+  subject do
+    Monolens.lens('array.map' => 'str.upcase')
+  end
+
+  it 'joins values with spaces' do
+    input = ['hello', 'world']
+    expected = ['HELLO', 'WORLD']
+    expect(subject.call(input)).to eql(expected)
+  end
+end

data/spec/monolens/core/test_mapping.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Monolens, 'core.mapping' do
+  let(:mapping) do
+    { 'values' => { 'todo' => 'open' }}
+  end
+
+  context 'with default options' do
+    subject do
+      Monolens.lens('core.mapping' => mapping)
+    end
+
+    it 'replaces the value by its mapped' do
+      expect(subject.call('todo')).to eql('open')
+    end
+
+    it 'returns nil if not found' do
+      expect(subject.call('nosuchone')).to eql(nil)
+    end
+  end
+
+  context 'specifying a default value' do
+    subject do
+      Monolens.lens('core.mapping' => mapping.merge('default' => 'foo'))
+    end
+
+    it 'replaces the value by its mapped' do
+      expect(subject.call('todo')).to eql('open')
+    end
+
+    it 'returns the default if not found' do
+      expect(subject.call('nosuchone')).to eql('foo')
+    end
+  end
+
+  context 'lets raise if not found' do
+    subject do
+      Monolens.lens('core.mapping' => mapping.merge('fail_if_missing' => true))
+    end
+
+    it 'replaces the value by its mapped' do
+      expect(subject.call('todo')).to eql('open')
+    end
+
+    it 'raises if not found' do
+      expect {
+        subject.call('nosuchone')
+      }.to raise_error(Monolens::LensError)
+    end
+  end
+end

data/spec/monolens/object/test_select.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Monolens, 'object.select' do
+  context 'when using symbols in the definition' do
+    subject do
+      Monolens.lens('object.select' => {
+        name: [:firstname, :lastname],
+        status: :priority
+      })
+    end
+
+    it 'works as expected' do
+      input = {
+        firstname: 'Bernard',
+        lastname: 'Lambeau',
+        priority: 12
+      }
+      expected = {
+        name: ['Bernard', 'Lambeau'],
+        status: 12
+      }
+      expect(subject.call(input)).to eql(expected)
+    end
+
+    it 'works as with Strings' do
+      input = {
+        'firstname' => 'Bernard',
+        'lastname' => 'Lambeau',
+        'priority' => 12
+      }
+      expected = {
+        'name' => ['Bernard', 'Lambeau'],
+        'status' => 12
+      }
+      expect(subject.call(input)).to eql(expected)
+    end
+  end
+
+  context 'when using strings in the definition' do
+    subject do
+      Monolens.lens('object.select' => {
+        'name' => ['firstname', 'lastname'],
+        'status' => 'priority'
+      })
+    end
+
+    it 'works as expected with Symbols' do
+      input = {
+        firstname: 'Bernard',
+        lastname: 'Lambeau',
+        priority: 12
+      }
+      expected = {
+        name: ['Bernard', 'Lambeau'],
+        status: 12
+      }
+      expect(subject.call(input)).to eql(expected)
+    end
+
+    it 'works with Strings' do
+      input = {
+        'firstname' => 'Bernard',
+        'lastname' => 'Lambeau',
+        'priority' => 12
+      }
+      expected = {
+        'name' => ['Bernard', 'Lambeau'],
+        'status' => 12
+      }
+      expect(subject.call(input)).to eql(expected)
+    end
+  end
+end

data/spec/monolens/skip/test_null.rb

@@ -17,7 +17,7 @@ describe Monolens, 'skip.null' do
 
   context 'when used in a Map' do
     subject do
-      Monolens.lens('map' => ['skip.null', 'str.upcase'])
+      Monolens.lens('array.map' => ['skip.null', 'str.upcase'])
     end
 
     it 'maps nils' do
@@ -27,7 +27,7 @@ describe Monolens, 'skip.null' do
 
   context 'when used in a Map, but we want no nils' do
     subject do
-      Monolens.lens(['array.compact', { 'map' => ['skip.null', 'str.upcase'] }])
+      Monolens.lens(['array.compact', { 'array.map' => ['skip.null', 'str.upcase'] }])
     end
 
     it 'works' do

data/spec/monolens/str/test_downcase.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Monolens, 'str.downcase' do
+  subject do
+    Monolens.lens('str.downcase')
+  end
+
+  it 'converts to lowercase' do
+    input = 'FOO'
+    expected = 'foo'
+    expect(subject.call(input)).to eql(expected)
+  end
+end

data/spec/monolens/str/test_split.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Monolens, 'str.split' do
+  context 'without options' do
+    subject do
+      Monolens.lens('str.split')
+    end
+
+    it 'splits a string as an array using space separator' do
+      input = 'foo bar'
+      expected = ['foo', 'bar']
+      expect(subject.call(input)).to eql(expected)
+    end
+
+    it 'is greedy on spaces and splits on carriage returns and tabs' do
+      input = "foo   bar\nbaz\tboz"
+      expected = ['foo', 'bar', 'baz', 'boz']
+      expect(subject.call(input)).to eql(expected)
+    end
+  end
+
+  context 'when specifying the separator' do
+    subject do
+      Monolens.lens('str.split' => { separator: ',' })
+    end
+
+    it 'uses it' do
+      input = 'foo,bar'
+      expected = ['foo', 'bar']
+      expect(subject.call(input)).to eql(expected)
+    end
+
+    it 'does not make whitespace magic' do
+      input = "foo, bar"
+      expected = ['foo', ' bar']
+      expect(subject.call(input)).to eql(expected)
+    end
+  end
+end

data/spec/monolens/str/test_strip.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Monolens, 'str.strip' do
+  subject do
+    Monolens.lens('str.strip')
+  end
+
+  it 'strips leading and trailing spaces' do
+    input = '   foo  '
+    expected = 'foo'
+    expect(subject.call(input)).to eql(expected)
+  end
+end

data/spec/monolens/str/test_upcase.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Monolens, 'str.upcase' do
+  subject do
+    Monolens.lens('str.upcase')
+  end
+
+  it 'converts to uppercase' do
+    input = 'foo'
+    expected = 'FOO'
+    expect(subject.call(input)).to eql(expected)
+  end
+end

data/spec/test_readme.rb

@@ -21,7 +21,7 @@ describe "What's said in README" do
     ---
     version: 1.0
     lenses:
-    - map:
+    - array.map:
       - object.transform:
           status:
           - str.upcase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monolens
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-04 00:00:00.000000000 Z
+date: 2022-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -65,38 +65,50 @@ files:
 - lib/monolens.rb
 - lib/monolens/array.rb
 - lib/monolens/array/compact.rb
+- lib/monolens/array/join.rb
+- lib/monolens/array/map.rb
 - lib/monolens/coerce.rb
 - lib/monolens/coerce/date.rb
 - lib/monolens/coerce/date_time.rb
 - lib/monolens/core.rb
 - lib/monolens/core/chain.rb
-- lib/monolens/core/map.rb
+- lib/monolens/core/mapping.rb
 - lib/monolens/error.rb
 - lib/monolens/file.rb
 - lib/monolens/lens.rb
 - lib/monolens/object.rb
 - lib/monolens/object/keys.rb
 - lib/monolens/object/rename.rb
+- lib/monolens/object/select.rb
 - lib/monolens/object/transform.rb
 - lib/monolens/object/values.rb
 - lib/monolens/skip.rb
 - lib/monolens/skip/null.rb
 - lib/monolens/str.rb
 - lib/monolens/str/downcase.rb
+- lib/monolens/str/split.rb
 - lib/monolens/str/strip.rb
 - lib/monolens/str/upcase.rb
 - lib/monolens/version.rb
 - spec/fixtures/coerce.yml
 - spec/fixtures/simple.yml
 - spec/fixtures/transform.yml
+- spec/monolens/array/test_compact.rb
+- spec/monolens/array/test_join.rb
+- spec/monolens/array/test_map.rb
 - spec/monolens/coerce/test_date.rb
 - spec/monolens/coerce/test_datetime.rb
-- spec/monolens/core/test_map.rb
+- spec/monolens/core/test_mapping.rb
 - spec/monolens/object/test_keys.rb
 - spec/monolens/object/test_rename.rb
+- spec/monolens/object/test_select.rb
 - spec/monolens/object/test_transform.rb
 - spec/monolens/object/test_values.rb
 - spec/monolens/skip/test_null.rb
+- spec/monolens/str/test_downcase.rb
+- spec/monolens/str/test_split.rb
+- spec/monolens/str/test_strip.rb
+- spec/monolens/str/test_upcase.rb
 - spec/monolens/test_lens.rb
 - spec/spec_helper.rb
 - spec/test_monolens.rb
@@ -122,7 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubyforge_project: 
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Data transformations inspired by Cambria lenses

data/spec/monolens/core/test_map.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe Monolens, 'map' do
-  subject do
-    Monolens.lens('map' => ['str.upcase'])
-  end
-
-  it 'maps as expected' do
-    expect(subject.call(['foo','bar'])).to eql(['FOO','BAR'])
-  end
-end