fast_ostruct 1.0.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed10c73a7bbd13261e7ceee225cae1b1a38d92cbdd43a6be2a8e95f061659830
+  data.tar.gz: 0c8a054cddf3955944c5763944f424e2eb16536ca3d7cb76c5efefea868bb376
+SHA512:
+  metadata.gz: 18d94168b2f35b5f49856686b8df0f8e33a434f68380e467b063a69287d8fb1822af47247c6fb59cd607feaebbef4c38a3fe526b07bf5a6a776e2cd4ead06c7f
+  data.tar.gz: e1413fbd90c3968118d6613e5ac6dd96efd74adf5081158a330d03df628b6dcd91a9942ad01328a402c58920b27975c06917a31b2bb51b5424922e7894e7f7b4

data/.github/workflows/fast-ostruct_ci.yml

@@ -0,0 +1,53 @@
+name: FastOpenStruct CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - name: Run specs
+      run: bundle exec rspec --format progress
+
+  publish:
+    needs: [test]
+#    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.8
+
+    - name: Publish to GitHub Packages Registry
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.PACKAGES_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+fast_open_struct*.gem
+
+# Devs stuffs
+.idea

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,68 @@
+require: rubocop-performance
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'spec/fixtures/**/*'
+    - '.git/**/*'
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false
+
+Style/FormatStringToken:
+  Exclude:
+    - spec/**/*
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+    - module_inclusion
+    - constants
+    - public_class_methods
+    - initializer
+    - instance_methods
+    - protected_methods
+    - private_methods
+
+# Trailing white space is meaningful in code examples
+Layout/TrailingWhitespace:
+  AllowInHeredoc: true
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/LineLength:
+  Max: 120
+  AllowedPatterns:
+    - !ruby/regexp /\A +(it|describe|context|shared_examples|include_examples|it_behaves_like) ["']/
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - '**/*.gemspec'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 15

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fast_open_struct.gemspec.
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Washington Silva
+
+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,123 @@
+# Fast OpenStruct
+
+It was inspirated on [DynamicClass](https://github.com/amcaplan/dynamic_class) gem.
+
+The main purpose of this gem is behave like an OpenStruct, but with some extra powers.
+
+The main difference for OpenStruct is that this implementation has a cache of the methods that are created, so it is faster.
+
+## Diferences from OpenStruct
+
+- It is faster
+- It has a cache of the methods that are created
+- It does not uses @table instance variable
+- It has a dig method that works like Hash#dig to access nested attributes
+- It implements some methods of **ActiveModel::API** and **ActiveModel::Serialization**, making it useful for some cases (i.e. using it as :class for FactoryBot factories)
+- It makes a deep initialization of the attributes, converting Hash to FastOpenStruct
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fast_ostruct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+    
+    $ gem install fast_ostruct
+
+
+## Usage
+
+```ruby
+require 'fast_ostruct'
+
+attributes = { name: 'John' }
+
+my_struct = FastOpenStruct.new(attributes)
+
+# Set attributes 
+my_struct.nickname = 'Big John'
+my_struct['lastname'] = 'Connor'
+my_struct[:age] = 30
+
+# Access attributes
+my_struct.name # => 'John'
+my_struct[:nickname] # => 'Big John'
+my_struct['lastname'] # => 'Connor'
+my_struct.dig(:age) # => 30
+```
+
+## Benchmarks
+```
+Initialization benchmark
+
+Warming up --------------------------------------
+          OpenStruct    15.041k i/100ms
+      FastOpenStruct   116.264k i/100ms
+Calculating -------------------------------------
+          OpenStruct    152.606k (± 2.4%) i/s -    767.091k in   5.029398s
+      FastOpenStruct      1.148M (± 1.4%) i/s -      5.813M in   5.063585s
+
+Comparison:
+      FastOpenStruct:  1148278.4 i/s
+          OpenStruct:   152606.3 i/s - 7.52x  slower
+
+
+
+Assignment Benchmark
+
+Warming up --------------------------------------
+          OpenStruct   682.010k i/100ms
+      FastOpenStruct     1.972M i/100ms
+Calculating -------------------------------------
+          OpenStruct      6.980M (± 3.3%) i/s -     35.465M in   5.086554s
+      FastOpenStruct     19.964M (± 0.8%) i/s -    100.582M in   5.038516s
+
+Comparison:
+      FastOpenStruct: 19964034.5 i/s
+          OpenStruct:  6980499.3 i/s - 2.86x  slower
+
+
+
+Access Benchmark
+
+Warming up --------------------------------------
+          OpenStruct     1.005M i/100ms
+      FastOpenStruct     2.185M i/100ms
+Calculating -------------------------------------
+          OpenStruct     10.085M (± 0.5%) i/s -     51.245M in   5.081712s
+      FastOpenStruct     21.798M (± 1.1%) i/s -    109.268M in   5.013290s
+
+Comparison:
+      FastOpenStruct: 21798290.7 i/s
+          OpenStruct: 10084528.1 i/s - 2.16x  slower
+
+
+
+All-Together Benchmark
+
+Warming up --------------------------------------
+          OpenStruct    12.918k i/100ms
+      FastOpenStruct   111.460k i/100ms
+Calculating -------------------------------------
+          OpenStruct    127.875k (± 2.7%) i/s -    645.900k in   5.054749s
+      FastOpenStruct      1.122M (± 1.1%) i/s -      5.684M in   5.066350s
+
+Comparison:
+      FastOpenStruct:  1122147.0 i/s
+          OpenStruct:   127874.6 i/s - 8.78x  slower
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+# 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
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'fast_ostruct'
+
+# 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

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/fast_ostruct.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/fast_ostruct'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'fast_ostruct'
+  spec.version     = FastOpenStruct::VERSION
+  spec.authors     = ['Washington Silva']
+  spec.email       = ['w-osilva@hotmail.com']
+  spec.homepage    = 'https://github.com/w-osilva/fast_ostruct'
+  spec.summary     = 'A fast open struct alternative'
+  spec.licenses    = ['MIT']
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['github_repo'] = spec.homepage
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'benchmark-ips', '>= 2'
+  spec.add_development_dependency 'pry', '>= 0.14'
+  spec.add_development_dependency 'rack-test', '~> 1.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.25'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.15'
+
+  spec.add_dependency 'json', '>= 2'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/fast_ostruct.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'set'
+
+class FastOpenStruct
+  VERSION = '1.0.0-alpha.1'
+
+  INITIALIZE_OPTIONS = { deep_initialize: true }.freeze
+  ATTRIBUTES_OPTIONS = { symbolize_keys: false }.freeze
+
+  def initialize(attributes = {}, options = INITIALIZE_OPTIONS)
+    if options[:deep_initialize]
+      attributes.except(*options.keys).each_pair do |name, value|
+        self[name] = deep_initialize(value, options)
+      end
+    else
+      attributes.except(*options.keys).each_pair do |name, value|
+        self[name] = value
+      end
+    end
+  end
+
+  def attributes(options = ATTRIBUTES_OPTIONS)
+    key_formatter = if options[:symbolize_keys]
+                      proc { |name| name.to_sym }
+                    else
+                      proc { |name| name.to_s }
+                    end
+
+    instance_variables.each_with_object({}) do |var, hash|
+      name = var.to_s.delete('@')
+      value = attribute_get(name)
+      hash[key_formatter.call(name)] = value.is_a?(FastOpenStruct) ? value.attributes(options) : value
+    end
+  end
+
+  # Serializable
+  def as_json(*_args)
+    attributes
+  end
+
+  def to_json(*_args)
+    attributes.to_json
+  end
+  alias serializable_hash attributes
+  alias to_h attributes
+
+  # Accessible
+  def [](name)
+    attribute_get(name)
+  end
+
+  def []=(name, value)
+    attribute_set(name, value)
+  end
+
+  def dig(name, *identifiers)
+    name = name.to_sym
+    identifiers.map!(&:to_sym) if identifiers.any?
+    attributes(symbolize_keys: true).dig(name, *identifiers)
+  end
+
+  def delete_field(name)
+    attribute_unset(name)
+  end
+
+  # Comparable
+  def ==(other)
+    other.is_a?(self.class) && attributes == other.attributes
+  end
+
+  def eql?(other)
+    other.is_a?(self.class) && attributes.eql?(other.attributes)
+  end
+
+  # Persistent
+  def persisted?
+    false
+  end
+
+  def save
+    self
+  end
+
+  def new_record?
+    true
+  end
+
+  alias save! save
+  alias create save
+  alias create! save
+  alias update save
+  alias update! save
+  alias delete save
+  alias destroy save
+  alias destroy! save
+  alias reload save
+
+  private
+
+  class << self
+    def defined_methods
+      @defined_methods ||= Set.new
+    end
+
+    def define_method!(name)
+      class_exec do
+        attr_writer name unless method_defined?("#{name}=")
+        attr_reader name unless method_defined?(name)
+        defined_methods << name
+      end
+    end
+  end
+
+  def deep_initialize(value, options = INITIALIZE_OPTIONS)
+    if value.is_a?(Array)
+      value = value.map { |v| v.is_a?(Hash) ? self.class.new(v, options) : v }
+    elsif value.is_a?(Hash)
+      value = self.class.new(value, options)
+    end
+    value
+  end
+
+  def attribute_set(name, value = nil)
+    return if name.nil?
+
+    name = name.to_sym
+    self.class.define_method!(name) unless self.class.defined_methods.include?(name)
+    instance_variable_set("@#{name}", value)
+  end
+
+  def attribute_get(name)
+    instance_variable_get("@#{name}")
+  end
+
+  def attribute_unset(name)
+    remove_instance_variable("@#{name}")
+  end
+
+  def method_missing(mid, *args)
+    if (mname = mid[/.*(?==\z)/m])
+      self[mname] = args.first
+    else
+      self[mid]
+    end
+  end
+
+  def respond_to_missing?(*args)
+    super(*args)
+  end
+end

data/lib/tasks/benchmark.rake

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'benchmark/ips'
+require 'fast_ostruct'
+require 'ostruct'
+
+# rubocop:disable Style/OpenStructUse
+namespace :fast_open_struct do
+  desc 'Run Benchmarking Examples'
+  task :benchmark do
+    puts "Initialization benchmark\n\n"
+    Benchmark.ips do |x|
+      input_hash = { foo: :bar }
+
+      x.report('OpenStruct') do
+        OpenStruct.new(input_hash)
+      end
+      x.report('FastOpenStruct') do
+        FastOpenStruct.new(input_hash)
+      end
+      x.compare!
+    end
+
+    puts "\n\nAssignment Benchmark\n\n"
+    Benchmark.ips do |x|
+      input_hash = { foo: :bar }
+      os = OpenStruct.new(input_hash)
+      fos = FastOpenStruct.new(input_hash)
+
+      x.report('OpenStruct') do
+        os.foo = :bar
+      end
+      x.report('FastOpenStruct') do
+        fos.foo = :bar
+      end
+      x.compare!
+    end
+
+    puts "\n\nAccess Benchmark\n\n"
+    Benchmark.ips do |x|
+      input_hash = { foo: :bar }
+      os = OpenStruct.new(input_hash)
+      fos = FastOpenStruct.new(input_hash)
+
+      x.report('OpenStruct') do
+        os.foo
+      end
+      x.report('FastOpenStruct') do
+        fos.foo
+      end
+      x.compare!
+    end
+
+    puts "\n\nAll-Together Benchmark\n\n"
+    Benchmark.ips do |x|
+      input_hash = { foo: :bar }
+
+      x.report('OpenStruct') do
+        os = OpenStruct.new(input_hash)
+        os.foo = :bar
+        os.foo
+      end
+      x.report('FastOpenStruct') do
+        fos = FastOpenStruct.new(input_hash)
+        fos.foo = :bar
+        fos.foo
+      end
+      x.compare!
+    end
+  end
+end
+# rubocop:enable Style/OpenStructUse

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: fast_ostruct
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha.1
+platform: ruby
+authors:
+- Washington Silva
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+description: 
+email:
+- w-osilva@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/fast-ostruct_ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fast_ostruct.gemspec
+- lib/fast_ostruct.rb
+- lib/tasks/benchmark.rake
+homepage: https://github.com/w-osilva/fast_ostruct
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/w-osilva/fast_ostruct
+  source_code_uri: https://github.com/w-osilva/fast_ostruct
+  github_repo: https://github.com/w-osilva/fast_ostruct
+  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: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A fast open struct alternative
+test_files: []