omg-attrs 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3eaed4c8a55dca3f9d6e4c6ecd00781116986cc1c81d1105960225bbfb74a85
-  data.tar.gz: 65c6269712e3e992694866d0c95a96b8d27b3542e78807c7a842cc1bcc4fbc25
+  metadata.gz: 46eb3e016278c743e4eef8261a80305e04df785d995a3296ddabc657abd7d1c0
+  data.tar.gz: 4ea3a9f88a0b4d606a81bdfa8b1a8834f95af409be473f570388cd202dc2805f
 SHA512:
-  metadata.gz: 4c5c5c1d6c2b3fa0604cb1c930f87b3953b62c3679066deca0818e132187cc37579037886f8ff0d1e0daaf4c426d7a0c68de0da2997b4380b41cc7d209754fa2
-  data.tar.gz: 04c77582e0256724d3ed1dfa090dd398a3b5da7e5c5e0b450b94bf388532ca076fa7f3a03dbf51ddf0e04201e81b9268284a88e6970105d6785ccff4a61b2ea5
+  metadata.gz: 521c7d6cf9f04759159669879341e6de02aa9996e05c52492dfeed32d14efb02f896eeb82ab80f6ac67a8fe6672656bad57f265f1d0058ac003b7a4a0cc73be5
+  data.tar.gz: 838d9945288f976fd547b7f817672dc391c95875c60d0743bb6022ebaf78c6fe49aa71de33eba721dd2e532d80199cae750a0177e3cc4c26244e7758854e3839

data/lib/attrs.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'pry-byebug'
+
 module Attrs
   def self.included(base)
     base.include(InstanceMethods)
@@ -7,8 +9,8 @@ module Attrs
 
   module InstanceMethods
     def attrs(*attrs)
-      return map { |i| i.attrs(*attrs) } if is_list?(self)
-
+      return list_attrs(attrs) if is_list?
+  
       base_attrs, nested_attrs = attrs.partition { |attr| attr.is_a?(Symbol) }
       nested_attrs.map! do |attr|
         if attr.is_a?(Hash)
@@ -21,25 +23,42 @@ module Attrs
           raise ArgumentError, "Invalid attribute: #{attr}"
         end
       end
-
-      base_attrs = base_attrs.to_h { |attr| [attr, get(attr)] }
+  
+      base_attrs = base_attrs.to_h do |attr|
+        [attr, get(attr)]
+      end
       nested_attrs.reduce(base_attrs, :merge)
     end
 
     private
 
-    def nested_attrs(attr)
-      attr.to_h do |key, value|
-        records = get(key)
+    ##
+    # Returns a hash containing attributes on the list and attributes on individual items.
+    # @param attrs [Array]
+    # @return [Hash]
+    def list_attrs(attrs)
+      list, nested = attrs.partition { |attr| attr.is_a?(Symbol) && respond_to?(attr) }
+      list_attrs = list.empty? ? {} : list.to_h { |key| [key, get(key)] }
+      nested_attrs = nested.empty? ? {} : { items: map { |i| i.attrs(*nested) } }
 
-        values = is_list?(records) ?
-          records.map { |record| record.attrs(*value) } :
-          records.attrs(*value)
+      list_attrs.merge(nested_attrs)
+    end
 
-        [key, values]
+    ##
+    # Recursively retrieves nested attributes.
+    #
+    # @param attr [Array | Hash]
+    def nested_attrs(attr)
+      attr.to_h do |key, value|
+        [key, get(key).attrs(*value)]
       end
     end
 
+    ##
+    # Gets a single attribute for any object. If the object is a hash, it will return the value for the key.
+    #
+    # @param key [Symbol]
+    # @return [Object]
     def get(key)
       if respond_to?(key)
         send(key)
@@ -51,8 +70,11 @@ module Attrs
       end
     end
 
-    def is_list?(object)
-      object.is_a?(Enumerable) && !object.is_a?(Hash)
+    ##
+    # Hacky way of determining if a non-hash object is a list but is not
+    #   technically an Array or Enumerable (e.g. ActiveRecord::Relation)
+    def is_list?
+      respond_to?(:each) && !is_a?(Hash)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omg-attrs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Matthew Greenfield
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies: []
 description: Makes it easy to slice and dice objects and collections of objects
 email:
@@ -17,18 +17,12 @@ 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
+homepage: https://github.com/omgreenfield/attrs
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/omgreenfield/omg-util/tree/main/attrs
+  homepage_uri: https://github.com/omgreenfield/attrs
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
@@ -45,7 +39,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.17
 signing_key: 
 specification_version: 4
 summary: Allows all objects to call `.attrs` which acts as a recursive `.slice` method

data/.rspec

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

data/.rubocop.yml

@@ -1,13 +0,0 @@
-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

@@ -1,45 +0,0 @@
-# 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

@@ -1,26 +0,0 @@
-# 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/spec/attrs_spec.rb

@@ -1,43 +0,0 @@
-# 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

@@ -1,15 +0,0 @@
-# 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