fast_ostruct 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a550fb9fdce2464d1b4f156eee3538ff7c214b53da5d704a2a54c326433e2fc
-  data.tar.gz: e11bde8d2b58a8cf595352a4d814364a2f08b51b5f33eb8404f6a8c2428c14e8
+  metadata.gz: 46b3703a02825829511af5040efa372482bdde0ea0df6ed66e3cd547ead5db37
+  data.tar.gz: e172571b4121f06c48a8042f1207c76734fadf9c80d41570798eb5eae668fb38
 SHA512:
-  metadata.gz: 5d7e83a8427f638bbc0c75c099a85c29cd9f2f8164fa3b2b0334c60409b9fa0a4bc0c0975974bee51db0b29392232c6f90aa53eb0489727bc5552351c6764a3f
-  data.tar.gz: 3306b542370c0ab7d0fa41a3e2ad1b4c5653f70dbb024c2b373f0224412f5e4e22dd6a1e615c5f37178ea07309a9e88c38d5521d201dec9a7e185ee3636a6fba
+  metadata.gz: 38f59dfe9385fd2d596520255a9db8a24997b16e947c117ccc827dc2fbd2c867f264a7e1870ff2dbd92f2c11e69949bfc95bbd2962e97b819680d1defbcb2fbb
+  data.tar.gz: 06db7c8fa97ad0c0f8d64dc8c2576ad8cefdfcb3c3e46df48295ab1af2355046c750c55477a08882a2e3592f07f1bf553213ba6efa71c03bd45b8b1ff7c55df4

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.1.0] - 2023-08-16
+
+### Added
+
+- Configuration file 
+- Changelog file
+- New method `slice` to slice attributes from FastOpenStruct
+
+### Fixed
+
+- Fixed bug when using `save` method with attributes (it happens when using as FactoryBot class). Thanks to [Andre Cesar Gomes](https://github.com/andrecego) for reporting this issue.
+
+### Changed
+
+- Readme file updated with new features documentation
+
+### Removed
+
+
+
+
+
+
+
+

data/Gemfile

@@ -3,4 +3,15 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fast_open_struct.gemspec.
+
+group :development, :test do
+  gem 'benchmark-ips', '>= 2'
+  gem 'pry', '>= 0.14'
+  gem 'rack-test', '~> 1.1'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '~> 1.25'
+  gem 'rubocop-performance', '~> 1.15'
+end
+
 gemspec

data/README.md

@@ -56,65 +56,79 @@ my_struct['lastname'] # => 'Connor'
 my_struct.dig(:age) # => 30
 ```
 
+## Configuration
+
+Create an initializer file and add the following code:
+```ruby
+FastOpenStruct.configure do |config|
+  # default: true | it will make a deep initialization of the attributes, converting Hash to FastOpenStruct 
+  config.initialize_options = { deep_initialize: true }
+  
+  # default: false | if true, it will symbolize the keys of the attributes
+  config.attributes_options = { symbolize_keys: false }
+end
+```
+
 ## Benchmarks
 ```
 Initialization benchmark
 
 Warming up --------------------------------------
-          OpenStruct    15.041k i/100ms
-      FastOpenStruct   116.264k i/100ms
+          OpenStruct     6.967k i/100ms
+      FastOpenStruct    45.819k 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
+          OpenStruct     70.614k (± 4.4%) i/s -    355.317k in   5.042038s
+      FastOpenStruct    454.480k (± 1.6%) i/s -      2.291M in   5.042112s
 
 Comparison:
-      FastOpenStruct:  1148278.4 i/s
-          OpenStruct:   152606.3 i/s - 7.52x  slower
+      FastOpenStruct:   454479.6 i/s
+          OpenStruct:    70614.1 i/s - 6.44x  slower
 
 
 
 Assignment Benchmark
 
 Warming up --------------------------------------
-          OpenStruct   682.010k i/100ms
-      FastOpenStruct     1.972M i/100ms
+          OpenStruct   317.626k i/100ms
+      FastOpenStruct     1.413M 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
+          OpenStruct      3.222M (± 0.3%) i/s -     16.199M in   5.027118s
+      FastOpenStruct     14.663M (± 1.0%) i/s -     73.465M in   5.010767s
 
 Comparison:
-      FastOpenStruct: 19964034.5 i/s
-          OpenStruct:  6980499.3 i/s - 2.86x  slower
+      FastOpenStruct: 14662985.4 i/s
+          OpenStruct:  3222330.4 i/s - 4.55x  slower
 
 
 
 Access Benchmark
 
 Warming up --------------------------------------
-          OpenStruct     1.005M i/100ms
-      FastOpenStruct     2.185M i/100ms
+          OpenStruct   455.965k i/100ms
+      FastOpenStruct     1.511M 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
+          OpenStruct      4.533M (± 3.2%) i/s -     22.798M in   5.034950s
+      FastOpenStruct     15.154M (± 0.5%) i/s -     77.063M in   5.085386s
 
 Comparison:
-      FastOpenStruct: 21798290.7 i/s
-          OpenStruct: 10084528.1 i/s - 2.16x  slower
+      FastOpenStruct: 15154237.8 i/s
+          OpenStruct:  4533257.4 i/s - 3.34x  slower
 
 
 
 All-Together Benchmark
 
 Warming up --------------------------------------
-          OpenStruct    12.918k i/100ms
-      FastOpenStruct   111.460k i/100ms
+          OpenStruct     5.084k i/100ms
+      FastOpenStruct   218.702k 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
+          OpenStruct     52.705k (± 4.7%) i/s -    264.368k in   5.027437s
+      FastOpenStruct      2.135M (± 4.1%) i/s -     10.716M in   5.028416s
 
 Comparison:
-      FastOpenStruct:  1122147.0 i/s
-          OpenStruct:   127874.6 i/s - 8.78x  slower
+      FastOpenStruct:  2135322.0 i/s
+          OpenStruct:    52704.7 i/s - 40.51x  slower
+
 ```
 
 ## Contributing

data/fast_ostruct.gemspec

@@ -24,14 +24,6 @@ Gem::Specification.new do |spec|
   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'

data/lib/fast_ostruct/config.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class FastOpenStruct
+  class Config
+    attr_accessor :initialize_options, :attributes_options
+
+    def initialize
+      @initialize_options = { deep_initialize: true }
+      @attributes_options = { symbolize_keys: false }
+    end
+  end
+end

data/lib/fast_ostruct/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class FastOpenStruct
+  VERSION = '1.1.0'
+end

data/lib/fast_ostruct.rb

@@ -2,14 +2,25 @@
 
 require 'json'
 require 'set'
+require_relative 'fast_ostruct/config'
+require_relative 'fast_ostruct/version'
 
 class FastOpenStruct
-  VERSION = '1.0.0'
+  class << self
+    def configure
+      yield config
+    end
 
-  INITIALIZE_OPTIONS = { deep_initialize: true }.freeze
-  ATTRIBUTES_OPTIONS = { symbolize_keys: false }.freeze
+    def config
+      @config ||= Config.new
+    end
+  end
 
-  def initialize(attributes = {}, options = INITIALIZE_OPTIONS)
+  def config
+    self.class.config
+  end
+
+  def initialize(attributes = {}, options = config.initialize_options)
     if options[:deep_initialize]
       attributes.except(*options.keys).each_pair do |name, value|
         self[name] = deep_initialize(value, options)
@@ -21,7 +32,7 @@ class FastOpenStruct
     end
   end
 
-  def attributes(options = ATTRIBUTES_OPTIONS)
+  def attributes(options = config.attributes_options)
     key_formatter = if options[:symbolize_keys]
                       proc { |name| name.to_sym }
                     else
@@ -41,12 +52,12 @@ class FastOpenStruct
   end
 
   def to_json(*_args)
-    attributes.to_json
+    JSON.generate(attributes)
   end
   alias serializable_hash attributes
   alias to_h attributes
 
-  # Accessible
+  # Hasheable
   def [](name)
     attribute_get(name)
   end
@@ -61,6 +72,11 @@ class FastOpenStruct
     attributes(symbolize_keys: true).dig(name, *identifiers)
   end
 
+  def slice(*names)
+    names.map!(&:to_sym)
+    attributes(symbolize_keys: true).slice(*names)
+  end
+
   def delete_field(name)
     attribute_unset(name)
   end
@@ -79,7 +95,7 @@ class FastOpenStruct
     false
   end
 
-  def save
+  def save(*)
     self
   end
 
@@ -104,16 +120,16 @@ class FastOpenStruct
       @defined_methods ||= Set.new
     end
 
-    def define_method!(name)
+    def define_methods!(name)
       class_exec do
-        attr_writer name unless method_defined?("#{name}=")
-        attr_reader name unless method_defined?(name)
+        attr_accessor name
+
         defined_methods << name
       end
     end
   end
 
-  def deep_initialize(value, options = INITIALIZE_OPTIONS)
+  def deep_initialize(value, options = config.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)
@@ -126,16 +142,16 @@ class FastOpenStruct
     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)
+    self.class.define_methods!(name) unless self.class.defined_methods.include?(name)
+    instance_variable_set(:"@#{name}", value)
   end
 
   def attribute_get(name)
-    instance_variable_get("@#{name}")
+    instance_variable_get(:"@#{name}")
   end
 
   def attribute_unset(name)
-    remove_instance_variable("@#{name}")
+    remove_instance_variable(:"@#{name}")
   end
 
   def method_missing(mid, *args)

data/lib/tasks/benchmark.rake

@@ -10,7 +10,7 @@ namespace :fast_open_struct do
   task :benchmark do
     puts "Initialization benchmark\n\n"
     Benchmark.ips do |x|
-      input_hash = { foo: :bar }
+      input_hash = { foo: :bar, bar: :baz, baz: :foo }
 
       x.report('OpenStruct') do
         OpenStruct.new(input_hash)
@@ -23,47 +23,60 @@ namespace :fast_open_struct do
 
     puts "\n\nAssignment Benchmark\n\n"
     Benchmark.ips do |x|
-      input_hash = { foo: :bar }
-      os = OpenStruct.new(input_hash)
-      fos = FastOpenStruct.new(input_hash)
+      os = OpenStruct.new
+      fos = FastOpenStruct.new
 
       x.report('OpenStruct') do
         os.foo = :bar
+        os.bar = :baz
+        os.baz = :foo
       end
       x.report('FastOpenStruct') do
         fos.foo = :bar
+        fos.bar = :baz
+        fos.baz = :foo
       end
       x.compare!
     end
 
     puts "\n\nAccess Benchmark\n\n"
     Benchmark.ips do |x|
-      input_hash = { foo: :bar }
+      input_hash = { foo: :bar, bar: :baz, baz: :foo }
       os = OpenStruct.new(input_hash)
       fos = FastOpenStruct.new(input_hash)
 
       x.report('OpenStruct') do
         os.foo
+        os.bar
+        os.baz
       end
       x.report('FastOpenStruct') do
         fos.foo
+        fos.bar
+        fos.baz
       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 = OpenStruct.new
         os.foo = :bar
         os.foo
+        os.bar = :baz
+        os.bar
+        os.baz = :foo
+        os.baz
       end
       x.report('FastOpenStruct') do
-        fos = FastOpenStruct.new(input_hash)
+        fos = FastOpenStruct.new
         fos.foo = :bar
         fos.foo
+        fos.bar = :baz
+        fos.bar
+        fos.baz = :foo
+        fos.baz
       end
       x.compare!
     end

metadata

@@ -1,113 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fast_ostruct
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Washington Silva
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-08-16 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
@@ -134,6 +36,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -142,6 +45,8 @@ files:
 - bin/setup
 - fast_ostruct.gemspec
 - lib/fast_ostruct.rb
+- lib/fast_ostruct/config.rb
+- lib/fast_ostruct/version.rb
 - lib/tasks/benchmark.rake
 homepage: https://github.com/w-osilva/fast_ostruct
 licenses: