accessory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43e0f691627cd491ac44fecb56547a50a5688215a1a65a494407557b9e6abc0b
+  data.tar.gz: 6775e183ab5791f8fb7e484593bc9cda59fde745a7f7bbfd38fd7fd3180a5c77
+SHA512:
+  metadata.gz: 9a258b50f71e28a4f43c934aa53fdb53e348665ae2c269a0f427fbc6febdda97a00e6891d12c5d9cb53a94be513a0c4e59d1739d6d11656aabf1898364738bcc
+  data.tar.gz: 7bfb51fa829b919ac35a78e0ee17aa9f2edd439e155df61c509dada8a94c8ed0f5c2d3915b1766869547b558685175d8691a3c7ccaffe32b5becd9d00445d2d1

data/lib/accessory.rb

@@ -0,0 +1,14 @@
+module Accessory; end
+
+require 'accessory/version'
+require 'accessory/lens_path'
+require 'accessory/lens'
+require 'accessory/access'
+
+module Accessory
+  refine ::Object do
+    def lens
+      ::Accessory::Lens.on(self)
+    end
+  end
+end

data/lib/accessory/access.rb

@@ -0,0 +1,107 @@
+module Accessory; end
+
+require 'accessory/accessors/subscript_accessor'
+require 'accessory/accessors/field_accessor'
+require 'accessory/accessors/filter_accessor'
+require 'accessory/accessors/instance_variable_accessor'
+require 'accessory/accessors/betwixt_accessor'
+require 'accessory/accessors/between_each_accessor'
+require 'accessory/accessors/all_accessor'
+require 'accessory/accessors/first_accessor'
+require 'accessory/accessors/last_accessor'
+
+module Accessory::Access
+  def self.field(...)
+    Accessory::FieldAccessor.new(...)
+  end
+
+  def self.ivar(...)
+    Accessory::InstanceVariableAccessor.new(...)
+  end
+
+  def self.betwixt(...)
+    Accessory::BetwixtAccessor.new(...)
+  end
+
+  def self.before_first
+    self.betwixt(0)
+  end
+
+  def self.after_last
+    self.betwixt(-1)
+  end
+
+  def self.between_each
+    Accessory::BetweenEachAccessor.new
+  end
+
+  def self.all
+    Accessory::AllAccessor.new
+  end
+
+  def self.first
+    Accessory::FirstAccessor.new
+  end
+
+  def self.last
+    Accessory::LastAccessor.new
+  end
+
+  def self.filter(&pred)
+    Accessory::FilterAccessor.new(pred)
+  end
+end
+
+module Accessory::Access::FluentHelpers
+  def [](...)
+    self.then(Accessory::SubscriptAccessor.new(...))
+  end
+
+  def field(...)
+    self.then(Accessory::FieldAccessor.new(...))
+  end
+
+  def ivar(...)
+    self.then(Accessory::InstanceVariableAccessor.new(...))
+  end
+
+  def betwixt(...)
+    self.then(Accessory::BetwixtAccessor.new(...))
+  end
+
+  def before_first
+    self.betwixt(0)
+  end
+
+  def after_last
+    self.betwixt(-1)
+  end
+
+  def between_each
+    self.then(Accessory::BetweenEachAccessor.new)
+  end
+
+  def all
+    self.then(Accessory::AllAccessor.new)
+  end
+
+  def first
+    self.then(Accessory::FirstAccessor.new)
+  end
+
+  def last
+    self.then(Accessory::LastAccessor.new)
+  end
+
+  def filter(&pred)
+    self.then(Accessory::FilterAccessor.new(pred))
+  end
+end
+
+class Accessory::Lens
+  include Accessory::Access::FluentHelpers
+end
+
+class Accessory::LensPath
+  include Accessory::Access::FluentHelpers
+end

data/lib/accessory/accessor.rb

@@ -0,0 +1,55 @@
+module Accessory; end
+
+class Accessory::Accessor
+  DEFAULT_NOT_SET_SENTINEL = :"98e47971-e708-42ca-bee7-0c62fe5e11c9"
+  TERMINAL_DEFAULT_FN = lambda{ nil }
+
+  def initialize(default: DEFAULT_NOT_SET_SENTINEL)
+    @default_value = default
+    @make_default_fn = TERMINAL_DEFAULT_FN
+  end
+
+  def name
+    n = self.class.name.split('::').last.gsub(/Accessor$/, '')
+    n.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+    n.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+    n.tr!("-", "_")
+    n.downcase!
+    n
+  end
+
+  def inspect(format: :long)
+    case format
+    when :long
+      parts = ["Access.#{self.name}", inspect_args].compact.join(' ')
+      "#<#{parts}>"
+    when :short
+      fn_name = "Access.#{self.name}"
+      args = inspect_args
+      args ? "#{fn_name}(#{args})" : fn_name
+    end
+  end
+
+  HIDDEN_IVARS = [:@default_value, :@make_default_fn]
+  def inspect_args
+    (instance_variables - HIDDEN_IVARS).map do |ivar_k|
+      ivar_v = instance_variable_get(ivar_k)
+      "#{ivar_k}=#{ivar_v.inspect}"
+    end.join(' ')
+  end
+
+  attr_accessor :make_default_fn
+
+  def value_or_default(data)
+    return nil if data.nil?
+
+    maybe_value = value_from(data)
+    return maybe_value unless maybe_value.nil?
+
+    if DEFAULT_NOT_SET_SENTINEL.equal?(@default_value)
+      @make_default_fn.call
+    else
+      @default_value
+    end
+  end
+end

data/lib/accessory/accessors/all_accessor.rb

@@ -0,0 +1,34 @@
+require 'accessory/accessor'
+
+class Accessory::AllAccessor < Accessory::Accessor
+  def default_fn_for_previous_step
+    lambda{ Array.new }
+  end
+
+  def inspect_args; nil; end
+
+  def get(data, &succ)
+    if succ
+      (data || []).map(&succ)
+    else
+      data
+    end
+  end
+
+  def get_and_update(data)
+    results = []
+    new_data = []
+
+    (data || []).each do |pos|
+      case yield(pos)
+      in [result, new_value]
+        results.push(result)
+        new_data.push(new_value)
+      in :pop
+        results.push(pos)
+      end
+    end
+
+    [results, new_data]
+  end
+end

data/lib/accessory/accessors/between_each_accessor.rb

@@ -0,0 +1,56 @@
+require 'accessory/accessor'
+require 'accessory/array_cursor_position'
+
+class Accessory::BetweenEachAccessor < Accessory::Accessor
+  def default_fn_for_previous_step
+    lambda{ Array.new }
+  end
+
+  def inspect_args; nil; end
+
+  def value_from(data)
+    data_len = data.length
+
+    positions = [
+      (0..data_len).to_a,
+      data + [nil],
+      [nil] + data
+    ]
+
+    positions.transpose.map do |(i, b, a)|
+      Accessory::ArrayCursorPosition.new(i, b, a, is_first: i == 0, is_last: i == data_len)
+    end
+  end
+
+  def get(data)
+    positions = value_or_default(data || [])
+
+    if block_given?
+      positions.map{ |rec| yield(rec) }
+    else
+      positions
+    end
+  end
+
+  def get_and_update(data)
+    results = []
+    new_data = []
+
+    positions = value_or_default(data || [])
+
+    positions.each do |pos|
+      case yield(pos)
+      in [result, new_value]
+        new_data.push(new_value)
+        results.push(result)
+      in :pop
+      end
+
+      unless pos.last?
+        new_data.push(pos.elem_after)
+      end
+    end
+
+    [results, new_data]
+  end
+end

data/lib/accessory/accessors/betwixt_accessor.rb

@@ -0,0 +1,52 @@
+require 'accessory/accessor'
+require 'accessory/array_cursor_position'
+
+class Accessory::BetwixtAccessor < Accessory::Accessor
+  def initialize(offset, **kwargs)
+    super(**kwargs)
+    @offset = offset
+  end
+
+  def inspect_args
+    @offset.inspect
+  end
+
+  def default_fn_for_previous_step
+    lambda{ Array.new }
+  end
+
+  def value_from(data)
+    data_len = data.length
+
+    Accessory::ArrayCursorPosition.new(
+      @offset,
+      (@offset > 0) ? data[@offset - 1] : nil,
+      (@offset < (data_len - 1)) ? data[@offset + 1] : nil,
+      is_first: @offset == 0,
+      is_last: @offset == data_len
+    )
+  end
+
+  def get(data)
+    pos = value_or_default(data || [])
+
+    if block_given?
+      yield(pos)
+    else
+      pos
+    end
+  end
+
+  def get_and_update(data)
+    pos = value_or_default(data || [])
+
+    case yield(pos)
+    in [result, new_value]
+      data ||= []
+      data.insert(@offset, new_value)
+      [result, data]
+    in :pop
+      [nil, data]
+    end
+  end
+end

data/lib/accessory/accessors/field_accessor.rb

@@ -0,0 +1,47 @@
+require 'accessory/accessor'
+
+class Accessory::FieldAccessor < Accessory::Accessor
+  def initialize(field_name, **kwargs)
+    super(**kwargs)
+    @getter_method_name = :"#{field_name}"
+    @setter_method_name = :"#{field_name}="
+  end
+
+  def inspect_args
+    @getter_method_name.inspect
+  end
+
+  def default_fn_for_previous_step
+    lambda do
+      require 'ostruct'
+      OpenStruct.new
+    end
+  end
+
+  def value_from(data)
+    data.send(@getter_method_name)
+  end
+
+  def get(data)
+    value = value_or_default(data)
+
+    if block_given?
+      yield(value)
+    else
+      value
+    end
+  end
+
+  def get_and_update(data)
+    value = value_or_default(data)
+
+    case yield(value)
+    in [result, new_value]
+      data.send(@setter_method_name, new_value)
+      [result, data]
+    in :pop
+      data.send(@setter_method_name, nil)
+      [value, data]
+    end
+  end
+end

data/lib/accessory/accessors/filter_accessor.rb

@@ -0,0 +1,45 @@
+require 'accessory/accessor'
+
+class Accessory::FilterAccessor < Accessory::Accessor
+  def initialize(pred)
+    @pred = pred
+  end
+
+  def inspect_args
+    @pred.inspect
+  end
+
+  def default_fn_for_previous_step
+    lambda{ Array.new }
+  end
+
+  def get(data, &succ)
+    if succ
+      (data || []).filter(&@pred).map(&succ)
+    else
+      data
+    end
+  end
+
+  def get_and_update(data)
+    results = []
+    new_data = []
+
+    (data || []).each do |pos|
+      unless @pred.call(pos)
+        new_data.push(pos)
+        next
+      end
+
+      case yield(pos)
+      in [result, new_value]
+        results.push(result)
+        new_data.push(new_value)
+      in :pop
+        results.push(pos)
+      end
+    end
+
+    [results, new_data]
+  end
+end

data/lib/accessory/accessors/first_accessor.rb

@@ -0,0 +1,36 @@
+require 'accessory/accessor'
+
+class Accessory::FirstAccessor < Accessory::Accessor
+  def default_fn_for_previous_step
+    lambda{ Array.new }
+  end
+
+  def inspect_args; nil; end
+
+  def value_from(data)
+    data.first
+  end
+
+  def get(data)
+    value = value_or_default(data)
+
+    if block_given?
+      yield(value)
+    else
+      value
+    end
+  end
+
+  def get_and_update(data)
+    old_value = value_or_default(data)
+
+    case yield(old_value)
+    in [result, new_value]
+      data[0] = new_value
+      [result, data]
+    in :pop
+      data.delete_at(0)
+      [old_value, data]
+    end
+  end
+end

data/lib/accessory/accessors/instance_variable_accessor.rb

@@ -0,0 +1,48 @@
+require 'accessory/accessor'
+
+class Accessory::InstanceVariableAccessor < Accessory::Accessor
+  def initialize(ivar_name, **kwargs)
+    super(**kwargs)
+
+    ivar_name = ivar_name.to_s
+    ivar_name = "@#{ivar_name}" unless ivar_name.to_s.start_with?("@")
+    ivar_name = ivar_name.intern
+
+    @ivar_name = ivar_name
+  end
+
+  def inspect_args
+    @ivar_name.to_s
+  end
+
+  def default_fn_for_previous_step
+    lambda{ Object.new }
+  end
+
+  def value_from(data)
+    data.instance_variable_get(@ivar_name)
+  end
+
+  def get(data)
+    value = value_or_default(data)
+
+    if block_given?
+      yield(value)
+    else
+      value
+    end
+  end
+
+  def get_and_update(data)
+    value = value_or_default(data)
+
+    case yield(value)
+    in [result, new_value]
+      data.instance_variable_set(@ivar_name, new_value)
+      [result, data]
+    in :pop
+      data.remove_instance_variable(@ivar_name)
+      [value, data]
+    end
+  end
+end

data/lib/accessory/accessors/last_accessor.rb

@@ -0,0 +1,36 @@
+require 'accessory/accessor'
+
+class Accessory::LastAccessor < Accessory::Accessor
+  def default_fn_for_previous_step
+    lambda{ Array.new }
+  end
+
+  def inspect_args; nil; end
+
+  def value_from(data)
+    data.last
+  end
+
+  def get(data)
+    value = value_or_default(data)
+
+    if block_given?
+      yield(value)
+    else
+      value
+    end
+  end
+
+  def get_and_update(data)
+    old_value = value_or_default(data)
+
+    case yield(old_value)
+    in [result, new_value]
+      data[-1] = new_value
+      [result, data]
+    in :pop
+      data.delete_at(-1)
+      [old_value, data]
+    end
+  end
+end

data/lib/accessory/accessors/subscript_accessor.rb

@@ -0,0 +1,52 @@
+require 'accessory/accessor'
+
+class Accessory::SubscriptAccessor < Accessory::Accessor
+  def initialize(key, **kwargs)
+    super(**kwargs)
+    @key = key
+  end
+
+  def inspect(format: :long)
+    case format
+    when :long
+      super()
+    when :short
+      @key.inspect
+    end
+  end
+
+  def inspect_args
+    @key.inspect
+  end
+
+  def default_fn_for_previous_step
+    lambda{ Hash.new }
+  end
+
+  def value_from(data)
+    data[@key]
+  end
+
+  def get(data)
+    value = value_or_default(data)
+
+    if block_given?
+      yield(value)
+    else
+      value
+    end
+  end
+
+  def get_and_update(data)
+    value = value_or_default(data)
+
+    case yield(value)
+    in [result, new_value]
+      data[@key] = new_value
+      [result, data]
+    in :pop
+      data.delete(@key)
+      [value, data]
+    end
+  end
+end

data/lib/accessory/array_cursor_position.rb

@@ -0,0 +1,18 @@
+module Accessory; end
+
+class Accessory::ArrayCursorPosition
+  def initialize(offset, elem_before, elem_after, is_first: false, is_last: false)
+    @offset = offset
+    @elem_before = elem_before
+    @elem_after = elem_after
+    @is_first = is_first
+    @is_last = is_last
+  end
+
+  attr_reader :offset
+  attr_reader :elem_before
+  attr_reader :elem_after
+
+  def first?; @is_first; end
+  def last?; @is_last; end
+end

data/lib/accessory/lens.rb

@@ -0,0 +1,66 @@
+module Accessory; end
+
+require 'accessory/lens_path'
+
+class Accessory::Lens
+  def self.on(doc, path: nil)
+    self.new(doc, path || Accessory::LensPath.empty).freeze
+  end
+
+  class << self
+    private :new
+  end
+
+  def initialize(doc, lens_path)
+    @doc = doc
+    @path = lens_path
+  end
+
+  attr_reader :path
+
+  def inspect
+    "#<Lens on=#{@doc.inspect} #{@path.inspect(format: :short)}>"
+  end
+
+  def then(accessor)
+    d = self.dup
+    d.instance_eval do
+      @path = @path.then(accessor)
+    end
+    d.freeze
+  end
+
+  def +(lens_path)
+    d = self.dup
+    d.instance_eval do
+      @path = @path + lens_path
+    end
+    d.freeze
+  end
+
+  def get_in
+    @path.get_in(@doc)
+  end
+
+  def get_and_update_in(&mutator_fn)
+    @path.get_and_update_in(@doc, &mutator_fn)
+  end
+
+  def update_in(&new_value_fn)
+    @path.update_in(@doc, &new_value_fn)
+  end
+
+  def put_in(new_value)
+    @path.put_in(@doc, new_value)
+  end
+
+  def pop_in
+    @path.pop_in(@doc)
+  end
+end
+
+class Accessory::LensPath
+  def on(doc)
+    Accessory::Lens.on(doc, path: self)
+  end
+end

data/lib/accessory/lens_path.rb

@@ -0,0 +1,140 @@
+module Accessory; end
+
+require 'accessory/accessor'
+require 'accessory/accessors/subscript_accessor'
+
+class Accessory::LensPath
+  def self.empty
+    @empty_lens_path ||= (new([]).freeze)
+  end
+
+  def self.[](*path)
+    new(path).freeze
+  end
+
+  class << self
+    private :new
+  end
+
+  def initialize(initial_parts)
+    @parts = []
+
+    for part in initial_parts
+      append_accessor!(part)
+    end
+  end
+
+  def to_a
+    @parts
+  end
+
+  def inspect(format: :long)
+    parts_desc = @parts.map{ |part| part.inspect(format: :short) }.join(', ')
+    parts_desc = "[#{parts_desc}]"
+
+    case format
+    when :long
+      "#LensPath#{parts_desc}"
+    when :short
+      parts_desc
+    end
+  end
+
+  def then(accessor)
+    d = self.dup
+    d.append_accessor!(accessor)
+    d.freeze
+  end
+
+  def dup
+    d = super
+    d.instance_eval do
+      @parts = @parts.dup
+    end
+    d
+  end
+
+  def +(lp_b)
+    raise ArgumentError unless lp_b.kind_of?(Accessory::LensPath)
+
+    d = self.dup
+    for part in lp_b.to_a
+      d.append_accessor!(part)
+    end
+    d.freeze
+  end
+
+  def append_accessor!(part)
+    accessor =
+      case part
+      when Accessory::Accessor
+        part
+      when Array
+        Accessory::SubscriptAccessor.new(part[0], default: part[1])
+      else
+        Accessory::SubscriptAccessor.new(part)
+      end
+
+    unless @parts.empty?
+      @parts.last.make_default_fn = accessor.default_fn_for_previous_step
+    end
+
+    @parts.push(accessor)
+  end
+
+  protected :append_accessor!
+
+  def get_in(doc)
+    if @parts.empty?
+      doc
+    else
+      get_in_step(doc, @parts)
+    end
+  end
+
+  def get_and_update_in(doc, &mutator_fn)
+    if @parts.empty?
+      doc
+    else
+      get_and_update_in_step(doc, @parts, mutator_fn)
+    end
+  end
+
+  def update_in(data, &new_value_fn)
+    _, new_data = self.get_and_update_in(data){ |v| [nil, new_value_fn.call(v)] }
+    new_data
+  end
+
+  def put_in(data, new_value)
+    _, new_data = self.get_and_update_in(data){ [nil, new_value] }
+    new_data
+  end
+
+  def pop_in(data)
+    self.get_and_update_in(data){ :pop }
+  end
+
+  private
+  def get_in_step(data, path)
+    step_accessor = path.first
+    rest_of_path = path[1..-1]
+
+    if rest_of_path.empty?
+      step_accessor.get(data)
+    else
+      step_accessor.get(data){ |v| get_in_step(v, rest_of_path) }
+    end
+  end
+
+  private
+  def get_and_update_in_step(data, path, mutator_fn)
+    step_accessor = path.first
+    rest_of_path = path[1..-1]
+
+    if rest_of_path.empty?
+      step_accessor.get_and_update(data, &mutator_fn)
+    else
+      step_accessor.get_and_update(data){ |v| get_and_update_in_step(v, rest_of_path, mutator_fn) }
+    end
+  end
+end

data/lib/accessory/version.rb

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

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: accessory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Levi Aul
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-10 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- levi@leviaul.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/accessory.rb
+- lib/accessory/access.rb
+- lib/accessory/accessor.rb
+- lib/accessory/accessors/all_accessor.rb
+- lib/accessory/accessors/between_each_accessor.rb
+- lib/accessory/accessors/betwixt_accessor.rb
+- lib/accessory/accessors/field_accessor.rb
+- lib/accessory/accessors/filter_accessor.rb
+- lib/accessory/accessors/first_accessor.rb
+- lib/accessory/accessors/instance_variable_accessor.rb
+- lib/accessory/accessors/last_accessor.rb
+- lib/accessory/accessors/subscript_accessor.rb
+- lib/accessory/array_cursor_position.rb
+- lib/accessory/lens.rb
+- lib/accessory/lens_path.rb
+- lib/accessory/version.rb
+homepage: https://github.com/tsutsu/accessory
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tsutsu/accessory
+  source_code_uri: https://github.com/tsutsu/accessory
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Functional lenses for Ruby, borrowed from Elixir
+test_files: []