pure-struct 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eace9d9756ad91444d1bf732bd2ac036e4b728a7b5fa1814f69a74cc416ae187
+  data.tar.gz: 066df3b27a861b53aa452c43ddd7197c7472003b46399b7a6d74efe21365035a
+SHA512:
+  metadata.gz: ef02fadf4e5e2689a6a8821fc9decc207193ddd8173036b582c37d3e6a9d30a636ec0d1694bc7bae4d6b6887534df1939b571ce9e1e244d02fb4cb615712a8b6
+  data.tar.gz: 43ade6064f84f4904023e571e9559762b04fa101ccad842c47e58af964cf363430d27eb1b37a509a4f719f6ed705100e4b8720eadb6d5d8f9f4dfcf5a464eab7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 1.0.0
+
+- Pure Ruby re-implementation of Struct

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2021 Andy maleh
+
+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,80 @@
+# Pure Struct
+[![Gem Version](https://badge.fury.io/rb/pure-struct.svg)](http://badge.fury.io/rb/pure-struct)
+[![rspec](https://github.com/AndyObtiva/pure-struct/workflows/rspec/badge.svg)](https://github.com/AndyObtiva/pure-struct/actions?query=workflow%3Arspec)
+[![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/pure-struct/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/pure-struct?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/2659b419fd5f7d38e443/maintainability)](https://codeclimate.com/github/AndyObtiva/pure-struct/maintainability)
+
+Pure [Ruby](https://www.ruby-lang.org/) re-implementation of [Struct](https://ruby-doc.org/core-2.7.0/Struct.html) to ensure cross-Ruby functionality where needed (e.g. [Opal](https://opalrb.com/))
+
+It is useful when:
+- There is a need for a Struct class that works consistently across esoteric implementations of [Ruby](https://www.ruby-lang.org/) like [Opal](https://opalrb.com/). This is useful when writing cross-[Ruby](https://www.ruby-lang.org/) apps like those of [Glimmer](https://github.com/AndyObtiva/glimmer) relying on [YASL](https://github.com/AndyObtiva/yasl) (Yet Another Serialization Library) in [Opal](https://opalrb.com/).
+- There is a need to meta-program Struct's data
+- There are no big performance requirements that demand native [Struct](https://ruby-doc.org/core-2.7.0/Struct.html)
+
+In all other cases, stick to native [Ruby Struct](https://ruby-doc.org/core-2.7.0/Struct.html) instead since it's optimized for performance.
+
+## Usage Instructions
+
+Run:
+
+`gem install pure-struct`
+
+Or add to [Gemfile](https://bundler.io/man/gemfile.5.html):
+
+```ruby
+gem 'pure-struct', '~> 1.0.0'
+```
+
+And, run:
+
+`bundle`
+
+Finally, require in [Ruby](https://www.ruby-lang.org/) code:
+
+```ruby
+require 'pure-struct'
+```
+
+Note that it removes the native `Struct` implementation first, aliasing as `NativeStruct` should you still need it, and then redefining `Struct` in pure [Ruby](https://www.ruby-lang.org/).
+
+Optionally, you may code block the require statement by a specific [Ruby](https://www.ruby-lang.org/) engine like [Opal](https://opalrb.com/):
+
+```
+if RUBY_ENGINE == 'opal'
+  require 'pure-struct'
+end
+```
+
+## Contributing to pure-struct
+
+-   Check out the latest master to make sure the feature hasn't been
+    implemented or the bug hasn't been fixed yet.
+-   Check out the issue tracker to make sure someone already hasn't
+    requested it and/or contributed it.
+-   Fork the project.
+-   Start a feature/bugfix branch.
+-   Commit and push until you are happy with your contribution.
+-   Make sure to add tests for it. This is important so I don't break it
+    in a future version unintentionally.
+-   Please try not to mess with the Rakefile, version, or history. If
+    you want to have your own version, or is otherwise necessary, that
+    is fine, but please isolate to its own commit so I can cherry-pick
+    around it.
+
+## Software Process
+
+[Glimmer Process](https://github.com/AndyObtiva/glimmer/blob/master/PROCESS.md)
+
+## TODO
+
+[TODO.md](TODO.md)
+
+## Change Log
+
+[CHANGELOG.md](CHANGELOG.md)
+
+## Copyright
+
+[MIT](LICENSE.txt)
+
+Copyright (c) 2021 Andy Maleh.

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/pure-struct.rb

@@ -0,0 +1,142 @@
+# Copyright (c) 2021 Andy maleh
+#
+# 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.
+
+NativeStruct = Struct
+Object.send(:remove_const, :Struct) if Object.constants.include?(:Struct)
+
+# Optional re-implmentation of Struct in Pure Ruby (to get around JS issues in Opal Struct)
+class Struct
+  class << self
+    CLASS_DEFINITION_FOR_ATTRIBUTES = lambda do |attributes, keyword_init|
+      lambda do |defined_class|
+        attributes.each do |attribute|
+          define_method(attribute) do
+            self[attribute]
+          end
+          define_method("#{attribute}=") do |value|
+            self[attribute] = value
+          end
+        end
+      
+        define_method(:members) do
+          (@members ||= attributes).clone
+        end
+        
+        def []=(attribute, value)
+          normalized_attribute = attribute.to_sym
+          raise NameError, "no member #{attribute} in struct" unless @members.include?(normalized_attribute)
+          @member_values[normalized_attribute] = value
+        end
+        
+        def [](attribute)
+          normalized_attribute = attribute.to_sym
+          raise NameError, "no member #{attribute} in struct" unless @members.include?(normalized_attribute)
+          @member_values[normalized_attribute]
+        end
+        
+        def each(&block)
+          to_a.each(&block)
+        end
+        
+        def each_pair(&block)
+          @member_values.each_pair(&block)
+        end
+        
+        def to_h
+          @member_values.clone
+        end
+        
+        def to_a
+          @member_values.values
+        end
+        
+        def size
+          @members.size
+        end
+        alias length size
+        
+        def dig(*args)
+          @member_values.dig(*args)
+        end
+        
+        def select(&block)
+          to_a.select(&block)
+        end
+        
+        def eql?(other)
+          instance_of?(other.class) &&
+            @members.all? { |key| self[key].eql?(other[key]) }
+        end
+        
+        def ==(other)
+          other = coerce(other).first if respond_to?(:coerce, true)
+          other.kind_of?(self.class) &&
+            @members.all? { |key| self[key] == other[key] }
+        end
+        
+        def hash
+          self.class.hash +
+            to_a.each_with_index.map {|value, i| (i+1) * value.hash}.sum
+        end
+        
+        if keyword_init
+          def initialize(struct_class_keyword_args = {})
+            members
+            @member_values = {}
+            struct_class_keyword_args.each do |attribute, value|
+              self[attribute] = value
+            end
+          end
+        else
+          def initialize(*attribute_values)
+            members
+            @member_values = {}
+            attribute_values.each_with_index do |value, i|
+              attribute = @members[i]
+              self[attribute] = value
+            end
+          end
+        end
+      end
+    end
+    
+    ARG_VALIDATION = lambda do |class_name_or_attribute, *attributes|
+      class_name_or_attribute.nil? || attributes.any?(&:nil?)
+    end
+    
+    CLASS_NAME_EXTRACTION = lambda do |class_name_or_attribute|
+      if class_name_or_attribute.is_a?(String)
+        raise NameError, "identifier name needs to be constant" unless class_name_or_attribute.match(/^[A-Z]/)
+        class_name_or_attribute
+      end
+    end
+    
+    def new(class_name_or_attribute, *attributes, keyword_init: false)
+      raise 'Arguments cannot be nil' if ARG_VALIDATION[class_name_or_attribute, *attributes]
+      class_name = CLASS_NAME_EXTRACTION[class_name_or_attribute]
+      attributes.unshift(class_name_or_attribute) if class_name.nil?
+      attributes = attributes.map(&:to_sym)
+      struct_class = Class.new(&CLASS_DEFINITION_FOR_ATTRIBUTES[attributes, keyword_init])
+      class_name.nil? ? struct_class : const_set(class_name, struct_class)
+    end
+      
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: pure-struct
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andy Maleh
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puts_debuggerer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pure Ruby re-implementation of Struct to ensure cross-Ruby functionality
+  where needed (e.g. Opal)
+email: andy.am@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- VERSION
+- lib/pure-struct.rb
+homepage: http://github.com/AndyObtiva/pure-struct
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Pure Ruby Re-Implementation of Struct
+test_files: []