trinkets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68ed0792dc692c54ba0b00f781bc49b0baf2ce0d79b98fca94c2807c5532e8d7
+  data.tar.gz: f5724dff46a3b64e7ee40ac72fb852bc8e47e0b6683fc95704c901bbd19c7f0b
+SHA512:
+  metadata.gz: 9d2738f9ce51557a84ae9c70896556d20cb321feb7ea31e9eee2be023dc25fa66bae7f85db4e720829b9d0338611b6c9c75e8fe7ac2f93df7db3728856c4bbf2
+  data.tar.gz: 2b0bb1da03c91f7eebff9a9f1994b5590c52cee0ab11b8643b1155805be00c79017092fcf49c017d52f95f1a8d08fc59e84659d913d4e35c6784b8bd7b541cba

data/.rspec

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 SilverPhoenix99
+
+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,53 @@
+# 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).

data/Rakefile

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

data/doc/class/init.md

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

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Trinkets
+  module Class
+    module Init
+      ATTR = %i[accessor reader writer].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)
+
+        default_attr_options = { attr: attr, kw: kw }
+
+        # Normalize attrs into a hash: { :name => **options }
+        # @type [Hash[Symbol, Hash]]
+        attrs = attrs.map { |a| [*a] }
+          .map { |a| a.size == 1 ? a << {} : a }
+          .each_with_object({}) do |(name, opts), h|
+            # name, opts = a
+            name = name.to_s.sub(/^@/, '').to_sym
+            opts = default_attr_options.merge(opts)
+            h[name] = opts
+          end
+
+        attr_methods = ATTR
+          .each_with_object({}) do |name, h|
+            h[name] = method("attr_#{name}")
+          end
+
+        # 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"
+          end
+          attr_methods[attr].call(name)
+        end
+
+        attrs.each { |name, opts| attr_init.call(name, **opts) }
+
+        # 2 hashes: { :name => bool }
+        kw_attrs, attrs = attrs
+          .map  { |name, opts| [name, opts[:kw]] }
+          .partition { |_, kw_opt| kw_opt }
+          .map(&:to_h)
+
+        init_method = ::Trinkets::Class.send :define_initialize, attrs, kw_attrs
+        define_method :initialize, init_method
+      end
+    end
+
+    class << self
+      # @param [Hash[Symbol  Boolean]] attrs
+      # @param [Hash[Symbol  Boolean]] kw_attrs
+      private def define_initialize(attrs, kw_attrs)
+        ->(*values, **kw_values) do
+
+          unless attrs.size == values.size
+            raise ArgumentError, "wrong number of arguments (given #{values.size}, expected #{attrs.size})"
+          end
+
+          missing_keys = kw_attrs.except(*kw_values.keys)
+          unless missing_keys.empty?
+            missing_keys = missing_keys.keys.map(&:inspect).join(', ')
+            raise ArgumentError, "missing keywords: #{missing_keys}"
+          end
+
+          unknown_keywords = kw_values.except(*kw_attrs.keys)
+          unless unknown_keywords.empty?
+            unknown_keywords = unknown_keywords.keys.map(&:to_sym).map(&:inspect).join(', ')
+            raise ArgumentError, "unknown keywords: #{unknown_keywords}"
+          end
+
+          attrs.keys.zip(values).each do |name, value|
+            instance_variable_set "@#{name}", value
+          end
+
+          kw_values.each do |name, value|
+            instance_variable_set "@#{name}", value
+          end
+
+        end
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,5 @@
+require_relative '../../extend/class/init'
+
+class ::Class
+  include ::Trinkets::Class::Init
+end

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

@@ -0,0 +1,11 @@
+require_relative '../../extend/class/init'
+
+module Trinkets
+  module Class
+    module Init
+      refine ::Class do
+        import_methods ::Trinkets::Class::Init
+      end
+    end
+  end
+end

data/lib/trinkets/version.rb

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

data/lib/trinkets.rb

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

data/trinkets.gemspec

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

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: trinkets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SilverPhoenix99
+- P3t3rU5
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-28 00:00:00.000000000 Z
+dependencies: []
+description: Truly outrageous trinkets.
+email:
+- antoniopedrosilvapinto@gmail.com
+- pedro.at.miranda@gmail.com
+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
+- lib/trinkets/version.rb
+- trinkets.gemspec
+homepage: http://nowhere.example.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://nowhere.example.com
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Trinkets in your box.
+test_files: []