camel_snake_struct 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e030119b3af6eaca6666865803895cf418913a62152decc3578af302ee62dc60
+  data.tar.gz: 9bd9ef3d9d215900202ba1388c13b784e54207f7e11accf96a6bd23332b0bcb7
+SHA512:
+  metadata.gz: eca1edf5388aa041ac1c68438a2e24139f4a2e9263470f766bef1ff65c95943bd5593dd47d9ffe14d423a7ada766aedc6f8834859b142551dc8593e4c84d2ee3
+  data.tar.gz: 0306446d56b056675a72d591ba125b7eaa1a98e507069d4cbedd76161b5983eff18d1e47de77306e8e4d44b074bb2517a08a6e1acbf0d8bd0d0a6aa2629aaa73

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+vendor/bundle
+gems.locked

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,21 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.4
+  Exclude:
+    - 'vendor/**/*'
+
+Style:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ClassLength:
+  Max: 200

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# 0.1.0
+* initial version

data/README.md

@@ -0,0 +1,81 @@
+# CamelSnake
+
+Easily access camelCased hashes in a ruby_friendly_way.
+Main focus is handling responses from APIs that use camelCased keys.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'camel_snake'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install camel_snake
+
+## Usage
+
+For once of hashes
+
+```ruby
+  result = CamelSnakeStruct.new('version' => 1, 'rubyVersion' => '2.5.0', 
+                                'sites' => [{ 'url' => "https://duckduckgo.com", 'searchEngine' => true }, 
+                                            { 'url' => "https://d.tube/", 'searchEngine' => false }])
+
+  puts result.version # 1
+  puts result.ruby_version # 2.5.0
+  puts result.sites[0].url # https://duckduckgo.com
+  puts result.sites[1].url # https://d.tube/
+  puts result.unknown # NoMethodError
+  puts result['version'] # 1
+```
+
+Or Learning Structs
+
+```ruby
+MyLearningStruct = Class.new(CamelSnakeStruct)
+
+result1 = MyLearningStruct.new('data' => [{ 'name' => 'Jeff' }])
+puts result1.data.map(&:name) # ["Jeff"]
+# never received errors key before
+puts result.errors # NoMethodError
+
+result2 = MyLearningStruct.new('errors' => ['failed to get response'])
+# it remembers the shape from the first succesfull request
+puts result2.data.map(&:name) # []
+puts result.errors # ["failed to get response"]
+
+MyLoadedStruct = Class.new(CamelSnakeStruct)
+
+MyLoadedStruct.example('data' => [{ 'name' => 'Jeff' }], 'errors' => [], 'date' => { 'timezone' => 'UTC', 'unixTime' => 0})
+
+result3 = MyLoadedStruct.new({'date' => { }})
+puts result3.data # []
+puts result3.errors # []
+puts result3.date.timezone # nil
+puts result3.date.unix_time # nil
+```
+
+### Limitations
+
+* Expects to receive a hash
+* Only works with string keys
+* Does not work well with keys that point to array of arrays
+* expects the hash to always have the same struct for learning structs
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/camel_snake.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "camel_snake_struct"
+
+# 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(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../gems.rb",
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../gems.rb",
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

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

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name          = "camel_snake_struct"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Grant Petersen-Speelman"]
+  spec.email         = ["grant@nexl.io"]
+
+  spec.summary       = "Easily access camelCased hashes in a ruby friendly way"
+  spec.description   = "Easily access camelCased hashes in a ruby friendly way"
+  spec.homepage      = "https://github.com/NEXL-LTS/camel_snake_struct-ruby"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/NEXL-LTS/camel_snake_struct-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/NEXL-LTS/camel_snake_struct/CHANGELOG.md"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency 'activesupport', '>= 3.2', '< 7.0'
+end

data/gems.rb

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in camel_snake.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rubocop"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "simplecov"
+
+if ENV['GEM_VERSIONS'] == 'min'
+  gem 'activesupport', '~> 3.2.0'
+end

data/lib/camel_snake_struct.rb

@@ -0,0 +1,139 @@
+require 'active_support/core_ext/string'
+
+class CamelSnakeStruct
+  def self.example(data)
+    new_example = new(data)
+    walk_example(new_example)
+  end
+
+  def self.walk_example(new_example)
+    new_example.send(:_method_to_key).keys.each do |m_name|
+      result = new_example.public_send(m_name)
+      if result.is_a?(CamelSnakeStruct)
+        walk_example(result)
+      elsif result.is_a?(Array) && result.first.is_a?(CamelSnakeStruct)
+        walk_example(result.first)
+      end
+    end
+  end
+
+  def initialize(hash)
+    @_raw_hash = hash&.to_h || {}
+    @_method_to_key = @_raw_hash.keys.each_with_object({}) do |key, mapping|
+      normalize_key = key.gsub('@', '').gsub('.', '_')
+      mapping[normalize_key] = key
+      mapping[normalize_key.underscore] = key
+    end
+  end
+
+  def [](key)
+    _val(@_raw_hash[key])
+  end
+
+  def to_h
+    to_hash
+  end
+
+  def to_hash
+    @_raw_hash
+  end
+
+  protected
+
+  attr_reader :_method_to_key
+
+  def _val(val)
+    if val.is_a?(Hash)
+      CamelSnakeStruct.new(val)
+    elsif val.is_a?(Array)
+      val.map { |v| _val(v) }
+    else
+      val
+    end
+  end
+
+  def method_missing(method_name, *arguments, &block)
+    camelize_key = __method_to_key(method_name)
+    if camelize_key
+      if _define_new_method(method_name, camelize_key)
+        send(method_name)
+      else # no method defined for empty arrays as we don't know what it returns
+        @_raw_hash[camelize_key]
+      end
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    camelize_key = __method_to_key(method_name)
+    !camelize_key.nil? || super
+  end
+
+  def __method_to_key(method_name)
+    @_method_to_key[method_name.to_s]
+  end
+
+  def _define_hash_method(name, key)
+    is_sub_class = self.class != CamelSnakeStruct
+    if is_sub_class
+      klass = _define_sub_class(name)
+      self.class.send(:define_method, name) { @_raw_hash[key] && klass.new(@_raw_hash[key]) }
+    else
+      define_singleton_method(name) { CamelSnakeStruct.new(@_raw_hash[key]) }
+    end
+  end
+
+  def _define_array_method(name, key)
+    is_sub_class = self.class != CamelSnakeStruct
+    if is_sub_class
+      klass = _define_sub_class(name.to_s.singularize)
+      self.class.send(:define_method, name) { (@_raw_hash[key] || []).map { |v| klass.new(v) } }
+    else
+      define_singleton_method(name) { @_raw_hash[key].map { |v| CamelSnakeStruct.new(v) } }
+    end
+  end
+
+  def _define_scaler_array_method(name, key)
+    is_sub_class = self.class != CamelSnakeStruct
+    if is_sub_class
+      self.class.send(:define_method, name) { (@_raw_hash[key] || []) }
+    else
+      define_singleton_method(name) { @_raw_hash[key] }
+    end
+  end
+
+  def _define_value_method(name, key)
+    is_sub_class = self.class != CamelSnakeStruct
+    if is_sub_class
+      self.class.send(:define_method, name) { @_raw_hash[key] }
+    else
+      define_singleton_method(name) { @_raw_hash[key] }
+    end
+  end
+
+  def _define_new_method(name, key)
+    name = name.to_sym
+    val = @_raw_hash[key]
+    if val.is_a?(Hash)
+      _define_hash_method(name, key)
+    elsif val.is_a?(Array) && val.first.is_a?(Hash)
+      _define_array_method(name, key)
+    elsif val.is_a?(Array) && val.empty?
+      return false
+    elsif val.is_a?(Array)
+      _define_scaler_array_method(name, key)
+    else
+      _define_value_method(name, key)
+    end
+    true
+  end
+
+  def _define_sub_class(name)
+    sub_class_name = name.to_s.camelize(:upper)
+    self.class.const_get(sub_class_name, false)
+  rescue NameError
+    self.class.const_set(sub_class_name, Class.new(CamelSnakeStruct))
+    self.class.const_get(sub_class_name, false)
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: camel_snake_struct
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Grant Petersen-Speelman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Easily access camelCased hashes in a ruby friendly way
+email:
+- grant@nexl.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- camel_snake_struct.gemspec
+- gems.rb
+- lib/camel_snake_struct.rb
+homepage: https://github.com/NEXL-LTS/camel_snake_struct-ruby
+licenses: []
+metadata:
+  homepage_uri: https://github.com/NEXL-LTS/camel_snake_struct-ruby
+  source_code_uri: https://github.com/NEXL-LTS/camel_snake_struct-ruby
+  changelog_uri: https://github.com/NEXL-LTS/camel_snake_struct/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.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: Easily access camelCased hashes in a ruby friendly way
+test_files: []