trinkets 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68ed0792dc692c54ba0b00f781bc49b0baf2ce0d79b98fca94c2807c5532e8d7
-  data.tar.gz: f5724dff46a3b64e7ee40ac72fb852bc8e47e0b6683fc95704c901bbd19c7f0b
+  metadata.gz: '018b1a7eeedc27c57853bd408ac7b698f1573f7b2646c7fdb8f36e2dce2b0add'
+  data.tar.gz: 50d9ec8927e0f127c17a410148c923e382b2749afe5ba87f13ef6d518349ecd4
 SHA512:
-  metadata.gz: 9d2738f9ce51557a84ae9c70896556d20cb321feb7ea31e9eee2be023dc25fa66bae7f85db4e720829b9d0338611b6c9c75e8fe7ac2f93df7db3728856c4bbf2
-  data.tar.gz: 2b0bb1da03c91f7eebff9a9f1994b5590c52cee0ab11b8643b1155805be00c79017092fcf49c017d52f95f1a8d08fc59e84659d913d4e35c6784b8bd7b541cba
+  metadata.gz: 73b50ad1d15f661512a2c1b230b993b6d4a9a56d5a8a72ebc9a7cd9cfe03989bd32897131f1991a071daaac50fdad2eaf8fb0cbfd4dd60430ea6de74c3cddbcc
+  data.tar.gz: 8643d7e712ef9798b459cb9dc28f35e72f4dc80215e2b860c7a23a06a4c029dac83d7271324f2605d6812d30c40ad96032d348fca2c1eeb62812c7923666e81f

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+
+### [0.3.0](https://github.com/SilverPhoenix99/trinkets/tree/v0.3.0)
+* Restructured folders to default to `/refine/`.
+* Added `Enumerable#each_with_hash`/`Enumerator#with_hash`.
+
+### [0.2.0](https://github.com/SilverPhoenix99/trinkets/tree/v0.2.0)
+* Added `attr: :none` as an option for `Class::init`.
+
+### [0.1.0](https://github.com/SilverPhoenix99/trinkets/tree/v0.1.0)
+* Added `Class::init`.

data/README.md

@@ -1,53 +1,82 @@
-# Trinkets
-
-It's the bootleg [facets](https://github.com/rubyworks/facets?tab=readme-ov-file#ruby-facets).
-
-## Installation
-
-```
-gem install trinkets
-```
-
-## Usage
-
-There are 3 ways to load trinkets:
-* As refinements;
-* As explicit `include` or `extend`;
-* As implicit `include` or `extend`, a.k.a. monkey-patching.
-
-### Refinement
-
-```ruby
-require 'trinkets/refine/class/init'
-
-using ::Trinkets::Class::Init
-```
-
-### Extend
-
-```ruby
-require 'trinkets/extend/class/init'
-
-class Test
-  extend ::Trinkets::Class::Init
-end
-```
-
-### Mokey Patching
-
-```ruby
-require 'trinkets/patch/class/init'
-```
-
-## Available modules
-
-|Trinket|
-|---|
-|[class/init](doc/class/init.md)|
-
-[//]: # (TODO: Development)
-[//]: # (TODO: Contributing)
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# Trinkets
+
+It's the bootleg [facets](https://github.com/rubyworks/facets?tab=readme-ov-file#ruby-facets).
+
+## Installation
+
+```
+gem install trinkets
+```
+
+## Usage
+
+The trinkets are loaded with the following structure:
+```ruby
+require 'trinkets/{how-to-patch}/{class}/{method}'
+```
+
+There are 3 ways to load trinkets, which are represented by the `{how-to-patch}` portion in the requires:
+* `refine` : As refinements;
+* `extend`/`include` : As explicit `extend` or `include`;
+* `patch` : As implicit `include` or `extend`, a.k.a. monkey-patching.
+
+### Refinement
+
+```ruby
+require 'trinkets/class/init'
+
+using ::Trinkets::Class::Init
+```
+
+The `refine` subdirectory is the default, and it can be omitted from `require`. The above is the same as:
+
+```ruby
+require 'trinkets/refine/class/init'
+```
+
+### Extend
+
+```ruby
+require 'trinkets/extend/class/init'
+
+class Test
+  extend ::Trinkets::Class::Init
+end
+```
+
+### Mokey Patching
+
+```ruby
+require 'trinkets/patch/class/init'
+```
+
+## Available modules
+
+|Trinket|
+|---|
+|[class/init](doc/class/init.md)|
+|[enumerable/each_with_hash](doc/enumerable/each_with_hash.md)|
+
+## Versioning
+
+Versions follow semantic versioning: `major.minor.patch`
+* `major`: breaking changes.
+* `minor`: improvements and new features that are backwards compatible.
+* `patch`: backwards compatible fixes to existing features, or documentation improvements.
+
+[//]: # (TODO: Development)
+
+## Contributing
+
+Steps to include when developing the feature/fix:
+* Add or change the appropriate RSpec tests.
+* Document the feature.
+  * Might not apply to fixes if the feature didn't change.
+* Bump the [version](lib/trinkets/version.rb).
+* Update the Changelog.
+
+[//]: # (TODO: Contributing)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/doc/class/init.md

@@ -1,122 +1,181 @@
-# Description
-
-It allows generating simple `#initialize` methods.
-
-To use it define a class and call `::init` like you would call `::attr` methods:
-* pass the name of the arguments as symbols
-* pass options at the end:
-  * `attr` : what getters and/or setters to define
-    * can be `:accessor`, `:reader` or `:writer` 
-    * defaults to `:accessor`
-  * `kw` : if arguments are to be set as keyword arguments
-    * defaults to `false`
-
-The same options can be used per individual argument
-
-# Examples
-
-## Simple Initialize
-```ruby
-class Test
-  init :a, :b
-end
-
-# would be the same as
-class Test
-  attr_accessor :a, :b
-  def initialize(a, b)
-    @a = a
-    @b = b
-  end
-end
-
-test = Test.new(1, 2)
-test.a
-# 1
-
-test.b
-# 2
-
-test.a = 3
-test.a
-# 3
-```
-
-## Read only access to instance variables
-```ruby
-class TestAttr
-  init :a, :b, attr: :reader
-end
-
-# would be the same as
-class Test
-  attr_reader :a, :b
-  def initialize(a, b)
-    @a = a
-    @b = b
-  end
-end
-
-test = Test.new(1, 2)
-test.a
-# 1
-
-test.b
-# 2
-
-test.a = 3
-# > raises ArgumentError
-```
-
-## Initialize uses keyword arguments
-```ruby
-class TestKW
-  init :a, :b, kw: :true
-end
-
-# would be the same as
-class Test
-  attr_accessor :a, :b
-  def initialize(a:, b:)
-    @a = a
-    @b = b
-  end
-end
-
-test = Test.new(a: 1, b: 2)
-test.a
-# 1
-
-test.b
-# 2
-```
-
-## Individual argument options
-```ruby
-class TestIndividualArgsOptions
-  init [:a, kw: true, attr: :reader], :b, [:c, kw: true]
-end
-
-# would be the same as
-class Test
-  attr_reader :a
-  attr_accessor :b, :c
-  def initialize(b, a:, c:)
-    @a = a
-    @b = b
-  end
-end
-
-test = Test.new(2, a: 1, c: 3)
-test.a
-# 1
-
-test.b
-# 2
-
-test.c
-# 3
-
-test.a = 4
-# > raises ArgumentError
-```
+# Description
+
+It allows generating simple `#initialize` methods.
+
+To use it, define a class and call `::init` like you would call `::attr` methods:
+* pass the name of the arguments as symbols
+* pass options at the end:
+  * `attr` : what getters and/or setters to define
+    * can be `:accessor`, `:reader`, `:writer` or `:none` 
+    * defaults to `:accessor`
+  * `kw` : if arguments are to be set as keyword arguments
+    * defaults to `false`
+
+The same options can be used per individual argument.
+
+# Requiring
+
+```ruby
+# As a refinement
+require 'trinkets/class/init' # implicit
+# or
+require 'trinkets/refine/class/init' # explicit 
+
+# As extend
+require 'trinkets/extend/class/init'
+
+# As monkey-patch
+require 'trinkets/patch/class/init'
+```
+
+# Examples
+
+## Simple Initialize
+```ruby
+class Test
+  init :a, :b
+end
+
+# would be the same as
+class Test
+  attr_accessor :a, :b
+  def initialize(a, b)
+    @a = a
+    @b = b
+  end
+end
+
+test = Test.new(1, 2)
+
+test.a
+# 1
+
+test.b
+# 2
+
+test.a = 3
+# 3
+```
+
+## Read only access to instance variables
+```ruby
+class TestAttr
+  init :a, :b, attr: :reader
+end
+
+# would be the same as
+class TestAttr
+  attr_reader :a, :b
+  def initialize(a, b)
+    @a = a
+    @b = b
+  end
+end
+
+test = TestAttr.new(1, 2)
+
+test.a
+# 1
+
+test.b
+# 2
+
+test.a = 3
+# => raises NoMethodError
+```
+
+## Initialize uses keyword arguments
+```ruby
+class TestKW
+  init :a, :b, kw: :true
+end
+
+# would be the same as
+class TestKW
+  attr_accessor :a, :b
+  def initialize(a:, b:)
+    @a = a
+    @b = b
+  end
+end
+
+test = TestKW.new(a: 1, b: 2)
+
+test.a
+# 1
+
+test.b
+# 2
+```
+
+## Individual attribute options
+```ruby
+class TestAttrOptions
+  init [:a, kw: true, attr: :reader],
+       :b,
+       [:c, kw: true],
+       [:d, attr: :none]
+end
+
+# would be the same as
+class TestAttrOptions
+  attr_reader :a
+  attr_accessor :b, :c
+  def initialize(b, d, a:, c:)
+    @a = a
+    @b = b
+    @c = c
+    @d = d
+  end
+end
+
+test = TestAttrOptions.new(2, 4, a: 1, c: 3)
+
+test.a
+# 1
+
+test.b
+# 2
+
+test.c
+# 3
+
+test.d
+# => raises NoMethodError
+
+test.a = 5
+# => raises NoMethodError
+```
+
+## Mixed together
+```ruby
+class TestMixed
+  init [:a, attr: :reader],
+       :b,
+       kw: true
+end
+
+# would be the same as
+class TestMixed
+  attr_reader :a
+  attr_accessor :b
+  def initialize(a:, b:)
+    @a = a
+    @b = b
+  end
+end
+
+test = TestMixed.new(1, 2)
+
+test.a
+# 1
+
+test.b
+# 2
+
+test.b = 3
+# 3
+
+test.a = 4
+# => raises NoMethodError
+```

data/doc/enumerable/each_with_hash.md

@@ -0,0 +1,47 @@
+# Description
+
+It defines `Enumerable#each_with_hash`, which is a simple wrapper for `Enumerable#each_with_object({})`.
+
+It also includes the alias `Enumerator#with_hash(&)`.
+
+# Requiring
+
+```ruby
+# As a refinement
+require 'trinkets/enumerable/each_with_hash' # implicit
+# or
+require 'trinkets/refine/enumerable/each_with_hash' # explicit 
+
+# As include
+require 'trinkets/include/enumerable/each_with_hash'
+
+# As monkey-patch
+require 'trinkets/patch/enumerable/each_with_hash'
+```
+
+# Examples
+
+These examples are all equivalent.
+
+```ruby
+[2, 3, 4, 5].each_with_hash { |value, hash| hash[value] = value * value }
+# => {2=>4, 3=>9, 4=>16, 5=>25}
+
+[2, 3, 4, 5].each_with_hash
+# => #<Enumerator: [2, 3, 4, 5]:each_with_object({})>
+```
+
+```ruby
+[2, 3, 4, 5].each
+  .with_hash { |value, hash| hash[value] = value * value }
+
+# => {2=>4, 3=>9, 4=>16, 5=>25}
+```
+
+```ruby
+[2, 3, 4, 5].each
+  .with_hash
+  .each { |value, hash| hash[value] = value * value }
+
+# => {2=>4, 3=>9, 4=>16, 5=>25}
+```

data/lib/{trinkets → explicit/trinkets}/extend/class/init.rb

@@ -3,11 +3,11 @@
 module Trinkets
   module Class
     module Init
-      ATTR = %i[accessor reader writer].freeze
+      ATTR = %i[accessor reader writer none].freeze
 
       def init(*attrs, attr: ATTR.first, kw: false)
         raise ArgumentError, 'At least 1 attribute is required.' if attrs.empty?
-        raise ArgumentError, '`attr` must be one of :accessor (default), :reader or :writer' unless ATTR.include?(attr)
+        raise ArgumentError, '`attr` must be one of :accessor (default), :reader, :writer or :none' unless ATTR.include?(attr)
 
         default_attr_options = { attr: attr, kw: kw }
 
@@ -22,7 +22,7 @@ module Trinkets
             h[name] = opts
           end
 
-        attr_methods = ATTR
+        attr_methods = (ATTR - [:none])
           .each_with_object({}) do |name, h|
             h[name] = method("attr_#{name}")
           end
@@ -30,9 +30,9 @@ module Trinkets
         # even though options like `kw` aren't used, they serve here to validate the `attrs` options
         attr_init = ->(name, attr: ATTR.first, kw: false) do
           unless ATTR.include?(attr)
-            raise ArgumentError, "attr `#{name}`, option attr` must be one of :accessor (default), :reader or :writer"
+            raise ArgumentError, "attr `#{name}`, option attr` must be one of :accessor (default), :reader, :writer or :none"
           end
-          attr_methods[attr].call(name)
+          attr_methods[attr].call(name) unless attr == :none
         end
 
         attrs.each { |name, opts| attr_init.call(name, **opts) }

data/lib/explicit/trinkets/include/enumerable/each_with_hash.rb

@@ -0,0 +1,14 @@
+module Trinkets
+
+  module Enumerable
+    module WithHash
+      def each_with_hash(&) = each_with_object({}, &)
+    end
+  end
+
+  module Enumerator
+    module WithHash
+      def with_hash(&) = each_with_hash(&)
+    end
+  end
+end

data/lib/explicit/trinkets/patch/enumerable/each_with_hash.rb

@@ -0,0 +1,9 @@
+require_relative '../../include/enumerable/each_with_hash'
+
+module ::Enumerable
+  include ::Trinkets::Enumerable::WithHash
+end
+
+class ::Enumerator
+  include ::Trinkets::Enumerator::WithHash
+end

data/lib/explicit/trinkets/refine/enumerable/each_with_hash.rb

@@ -0,0 +1,15 @@
+require_relative '../../include/enumerable/each_with_hash'
+
+module Trinkets
+  module Enumerable
+    module WithHash
+      refine ::Enumerable do
+        import_methods ::Trinkets::Enumerable::WithHash
+      end
+
+      refine ::Enumerator do
+        import_methods ::Trinkets::Enumerator::WithHash
+      end
+    end
+  end
+end

data/lib/implicit/trinkets/class/init.rb

@@ -0,0 +1 @@
+require_relative '../../../explicit/trinkets/refine/class/init'

data/lib/implicit/trinkets/enumerable/each_with_hash.rb

@@ -0,0 +1 @@
+require_relative '../../../explicit/trinkets/refine/enumerable/each_with_hash'

data/lib/trinkets/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trinkets
-  VERSION = "0.1.0"
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trinkets
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - SilverPhoenix99
@@ -9,9 +9,9 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-02-03 00:00:00.000000000 Z
 dependencies: []
-description: Truly outrageous trinkets.
+description: Truly outrageous bootleg facets in your trinkets box.
 email:
 - antoniopedrosilvapinto@gmail.com
 - pedro.at.miranda@gmail.com
@@ -19,40 +19,44 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - doc/class/init.md
-- lib/trinkets.rb
-- lib/trinkets/extend/class/init.rb
-- lib/trinkets/patch/class/init.rb
-- lib/trinkets/refine/class/init.rb
+- doc/enumerable/each_with_hash.md
+- lib/explicit/trinkets/extend/class/init.rb
+- lib/explicit/trinkets/include/enumerable/each_with_hash.rb
+- lib/explicit/trinkets/patch/class/init.rb
+- lib/explicit/trinkets/patch/enumerable/each_with_hash.rb
+- lib/explicit/trinkets/refine/class/init.rb
+- lib/explicit/trinkets/refine/enumerable/each_with_hash.rb
+- lib/implicit/trinkets/class/init.rb
+- lib/implicit/trinkets/enumerable/each_with_hash.rb
 - lib/trinkets/version.rb
-- trinkets.gemspec
-homepage: http://nowhere.example.com
+homepage: https://github.com/SilverPhoenix99/trinkets
 licenses:
 - MIT
 metadata:
-  homepage_uri: http://nowhere.example.com
+  homepage_uri: https://github.com/SilverPhoenix99/trinkets
 post_install_message:
 rdoc_options: []
 require_paths:
-- lib
+- lib/explicit
+- lib/implicit
+- lib/trinkets
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
-summary: Trinkets in your box.
+summary: Bootleg facets, with new trinkets.
 test_files: []

data/.rspec

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

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/lib/trinkets.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'trinkets/version'

data/trinkets.gemspec

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/trinkets/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'trinkets'
-  spec.version = Trinkets::VERSION
-  spec.authors = %w[SilverPhoenix99 P3t3rU5]
-  spec.email = %w[antoniopedrosilvapinto@gmail.com pedro.at.miranda@gmail.com]
-
-  spec.summary = 'Trinkets in your box.'
-  spec.description = 'Truly outrageous trinkets.'
-  spec.homepage = 'http://nowhere.example.com'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.2.0'
-
-  # spec.metadata['allowed_push_host'] = 'TODO: Set to your gem server "https://example.com"'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  # spec.metadata['source_code_uri'] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
-
-  # 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(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
-    end
-  end
-  spec.require_paths = ['lib']
-end