omg-attrs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f3eaed4c8a55dca3f9d6e4c6ecd00781116986cc1c81d1105960225bbfb74a85
+  data.tar.gz: 65c6269712e3e992694866d0c95a96b8d27b3542e78807c7a842cc1bcc4fbc25
+SHA512:
+  metadata.gz: 4c5c5c1d6c2b3fa0604cb1c930f87b3953b62c3679066deca0818e132187cc37579037886f8ff0d1e0daaf4c426d7a0c68de0da2997b4380b41cc7d209754fa2
+  data.tar.gz: 04c77582e0256724d3ed1dfa090dd398a3b5da7e5c5e0b450b94bf388532ca076fa7f3a03dbf51ddf0e04201e81b9268284a88e6970105d6785ccff4a61b2ea5

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.7.8
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 120

data/README.md

@@ -0,0 +1,45 @@
+# Attrs
+
+## Installation
+
+### Testing locally
+```sh
+# Build gem
+gem build attrs.gemspec
+
+# Install gem
+gem i -l /path/to/this/folder/omg-attrs-0.1.0.gem
+```
+
+## Usage
+
+```ruby
+dad_hash = {
+  age: 35,
+  hair_color: 'brown',
+  children: [
+    { age: 7, hair_color: 'blonde' },
+    { age: 3, hair_color: 'brown' }
+  ],
+  wife: { age: 35, hair_color: 'brown' }
+}
+
+dad_hash.attrs(:age) # => 35
+dad_hash.attrs(wife: :age, children: :hair_color) # =>
+# {
+#   wife: 35,
+#   children: [
+#     { hair_color: 'blonde' },
+#     { hair_color: 'brown'  },
+#   ],
+# }
+```
+
+## Running tests
+
+```ruby
+rspec
+
+# or
+bundle exec rspec
+```

data/attrs.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = 'omg-attrs'
+  spec.version = '0.1.0'
+  spec.authors = ['Matthew Greenfield']
+  spec.email = ['mattgreenfield1@gmail.com']
+
+  spec.summary = 'Allows all objects to call `.attrs` which acts as a recursive `.slice` method'
+  spec.description = 'Makes it easy to slice and dice objects and collections of objects'
+
+  spec.homepage = 'https://github.com/omgreenfield/omg-util/tree/main/attrs'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[spec/.git .github Gemfile])
+    end
+  end
+  spec.require_paths = ['lib']
+end

data/lib/attrs.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Attrs
+  def self.included(base)
+    base.include(InstanceMethods)
+  end
+
+  module InstanceMethods
+    def attrs(*attrs)
+      return map { |i| i.attrs(*attrs) } if is_list?(self)
+
+      base_attrs, nested_attrs = attrs.partition { |attr| attr.is_a?(Symbol) }
+      nested_attrs.map! do |attr|
+        if attr.is_a?(Hash)
+          nested_attrs(attr)
+        elsif attr.is_a?(Array) && attr.size == 2 && attr.first.is_a?(Symbol)
+          nested_attrs([attr].to_h)
+        elsif attr.is_a?(Array)
+          attr.map { |a| a.attrs(a) }
+        else
+          raise ArgumentError, "Invalid attribute: #{attr}"
+        end
+      end
+
+      base_attrs = base_attrs.to_h { |attr| [attr, get(attr)] }
+      nested_attrs.reduce(base_attrs, :merge)
+    end
+
+    private
+
+    def nested_attrs(attr)
+      attr.to_h do |key, value|
+        records = get(key)
+
+        values = is_list?(records) ?
+          records.map { |record| record.attrs(*value) } :
+          records.attrs(*value)
+
+        [key, values]
+      end
+    end
+
+    def get(key)
+      if respond_to?(key)
+        send(key)
+      elsif is_a?(Hash)
+        self[key]
+      else
+        # Denoting that the object does not respond to that key
+        NilClass
+      end
+    end
+
+    def is_list?(object)
+      object.is_a?(Enumerable) && !object.is_a?(Hash)
+    end
+  end
+end
+
+Object.include Attrs

data/spec/attrs_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+RSpec.describe Attrs do
+  it 'allows recursive slice-like attribute fetching' do
+    dad_hash = {
+      age: 35,
+      hair_color: 'brown',
+      children: [
+        { age: 7, hair_color: 'blonde' },
+        { age: 3, hair_color: 'brown' }
+      ],
+      wife: { age: 35, hair_color: 'brown' }
+    }
+
+    expect(dad_hash.attrs(:age, wife: %i[hair_color age], children: %i[hair_color age])).to eq(
+      {
+        age: 35,
+        wife: { hair_color: 'brown', age: 35 },
+        children: [
+          { hair_color: 'blonde', age: 7 },
+          { hair_color: 'brown', age: 3 },
+        ],
+      }
+    )
+
+    dad_object = OpenStruct.new(dad_hash)
+    expect(dad_object.attrs(:age, wife: %i[hair_color age], children: %i[hair_color age])).to eq(
+      {
+        age: 35,
+        wife: { hair_color: 'brown', age: 35 },
+        children: [
+          { hair_color: 'blonde', age: 7 },
+          { hair_color: 'brown', age: 3 },
+        ],
+      }
+    )
+
+    children_array = dad_object.children
+    expect(children_array.attrs(:hair_color, :age)).to eq([{ hair_color: 'blonde', age: 7 }, { hair_color: 'brown', age: 3 }])
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "attrs"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: omg-attrs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Greenfield
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-04-30 00:00:00.000000000 Z
+dependencies: []
+description: Makes it easy to slice and dice objects and collections of objects
+email:
+- mattgreenfield1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- README.md
+- attrs.gemspec
+- lib/attrs.rb
+- spec/attrs_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/omgreenfield/omg-util/tree/main/attrs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/omgreenfield/omg-util/tree/main/attrs
+  rubygems_mfa_required: 'true'
+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.5.9
+signing_key: 
+specification_version: 4
+summary: Allows all objects to call `.attrs` which acts as a recursive `.slice` method
+test_files: []