sorta-lens 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60447887a149122646f86543ebb0a25f2bb6ed4af3ddd4d6592421df60c6fd47
+  data.tar.gz: 15ad22d511ccbbb43c18cbf7e73a463b4c7f07669280399fa5eae52bf56be60b
+SHA512:
+  metadata.gz: ea4c1a0c6046b5abaf4beb8e09e8cafb182ee33ccd3ec92710bf418cd07fe3c2dd09a5d90236c852d6487a4a5affa46ffe4d424267a29c141f03e3c12fb6aec0
+  data.tar.gz: 938bbe6f04fc6ee83e6badc178719dd47a26576d75bd4ae6c03f75fb4d9f245d5169f705911b0c9ff5a13d5787da23c753d2333653e32b747d06522a1a0e0fd0

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Lint/DuplicateBranch:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sorta-lens.gemspec
+gemspec
+
+group :development, :test do
+  gem "rake", "~> 13.0"
+
+  gem "rspec", "~> 3.0"
+
+  gem "rubocop", "~> 1.7"
+
+  gem "rubocop-rake"
+  gem "rubocop-rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    sorta-lens (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.21.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.5.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  rubocop-rake
+  rubocop-rspec
+  sorta-lens!
+
+BUNDLED WITH
+   2.2.27

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ivan Chinenov
+
+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,20 @@
+# Sorta-lens
+Simple lensing for your data extraction needs
+
+## Usage
+Simply instantiate a Lens and start applying it to your objects:
+```ruby
+  complex1 = { id: 451, .... status: :active }
+  complex2 = User.first # has property `id` and method `status`
+  lens = Lens.on :id, :status
+  lens.(complex1) # => { id: 451, status: :active }
+  lens.(complex2) # => { id: 1, status: :online }
+```
+There is also a typed version:
+```ruby
+  complex1 = { id: 451, .... status: :active }
+  complex2 = { id: 9001, .... status: "online" }
+  lens = TypedLens.on id: Integer, status: String
+  lens.(complex1) # => TypedLens::TypeError (Unexpected type. Expected String got Symbol)
+  lens.(complex2) # => { id: 9001, status: "online" }
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sorta/lens"
+
+# 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/lib/lens/lens.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Sorta
+  # Lens builder
+  class Lens
+    def self.todo!
+      raise StandardError, "Unimplemented!"
+    end
+
+    def self.typed
+      new.typed
+    end
+
+    def self.indifferent
+      new.indifferent
+    end
+
+    def self.on(...)
+      new.on(...)
+    end
+
+    def initialize
+      @typed = false
+      @indifferent = false
+    end
+
+    def typed
+      @typed = true
+      self
+    end
+
+    def indifferent
+      @indifferent = true
+      self
+    end
+
+    def on(...)
+      case [@indifferent, @typed]
+      when [true, true]
+        todo!
+      when [true, false]
+        todo!
+      when [false, false]
+        Untyped.new(...)
+      when [false, true]
+        Typed.new(...)
+      end
+    end
+  end
+end

data/lib/lens/typed_lens.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Sorta
+  class Lens
+    # Extracts data from a given object
+    class Typed
+      def self.on(...)
+        new(...)
+      end
+
+      def initialize(**kwargs)
+        @kwargs = kwargs
+        validate_arguments
+      end
+
+      def call(object)
+        @kwargs.each_with_object({}) do |(sym, _ty), acc|
+          val = extract(sym, object)
+          acc[sym] = typecheck(sym, val)
+        end
+      end
+
+      def validate_arguments
+        @kwargs.each do |(sym, ty)|
+          unless sym.is_a?(Symbol) && ty.is_a?(Class)
+            raise ArgumentError,
+                  "Unexpected argument (#{sym.class} => #{ty.class}), must be (Symbol => Class)"
+          end
+        end
+      end
+
+      def extract(sym, object)
+        object.send(sym)
+      rescue NoMethodError
+        object[sym]
+      end
+
+      def typecheck(sym, val)
+        ty = @kwargs[sym]
+        return val if val.is_a?(ty)
+
+        raise TypeError.new val.class, ty
+      end
+    end
+  end
+end

data/lib/lens/untyped.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sorta
+  class Lens
+    # Extracts data from a given object
+    class Untyped
+      def self.on(...)
+        new(...)
+      end
+
+      def initialize(*args)
+        @args = args
+        validate_arguments
+      end
+
+      def call(object)
+        @args.each_with_object({}) do |sym, acc|
+          acc[sym] = object.send(sym)
+        rescue NoMethodError
+          acc[sym] = object[sym]
+        end
+      end
+
+      def validate_arguments
+        @args.each do |sym|
+          unless sym.is_a?(Symbol)
+            raise ArgumentError,
+                  "Unexpected argument #{sym.class}, must be Symbol"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sorta-lens.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "lens/lens"
+require_relative "lens/typed_lens"
+require_relative "lens/untyped"
+require_relative "version"
+module Sorta
+  class TypeError < RuntimeError
+    def initialize(expected_ty, actual_ty)
+      super "Unexpected type. Expected #{expected_ty} got #{actual_ty}"
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sorta
+  class Lens
+    VERSION = "0.1.0"
+  end
+end

data/sorta-lens.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sorta-lens"
+  spec.version       = Sorta::Lens::VERSION
+  spec.authors       = ["Ivan Chinenov"]
+  spec.email         = ["ichinenov@gmail.com"]
+
+  spec.summary       = "Simple lensing for your data extraction needs"
+  spec.homepage      = "https://github.com/sorta-rb/sorta-lens"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sorta-rb/sorta-lens"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: sorta-lens
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Chinenov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-27 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- ichinenov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lens/lens.rb
+- lib/lens/typed_lens.rb
+- lib/lens/untyped.rb
+- lib/sorta-lens.rb
+- lib/version.rb
+- sorta-lens.gemspec
+homepage: https://github.com/sorta-rb/sorta-lens
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sorta-rb/sorta-lens
+  source_code_uri: https://github.com/sorta-rb/sorta-lens
+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.1.4
+signing_key:
+specification_version: 4
+summary: Simple lensing for your data extraction needs
+test_files: []