simple-immutable 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee7113a903d3124b8d4c64499cc3dcd3ae296d6d4b45c6178b5205c3baae8675
+  data.tar.gz: 722814d2e633c8a7ea57c71b5add682ee62f46bffc113ad2047bc1b281dc9516
+SHA512:
+  metadata.gz: a6328926689c3ded5d5e6a3ae4f24b0fcc73663ef0d2aec26019c0ec6fc705c8f7da903fcb9aba8a917c75884b3299f603d3f521af95bf5cd4b7d7dd6f8c2c0c
+  data.tar.gz: adae1e19d19f7ce6a4c152b6137d27689c679d11ca91150bf04fd49115f8ba67ec080f1f2ba965e2e8111a08ce6ef3b58b4ef7bdefbb9730adadd63a6ff434b2

data/.gitignore

@@ -0,0 +1,10 @@
+coverage
+rdoc
+pkg
+log/test.log
+.rspec.data
+Gemfile.lock
+.rake_t_cache
+.rspec.status
+.DS_Store
+tmp

data/.tm_properties

@@ -0,0 +1,9 @@
+# Settings
+fontName         = "Menlo"
+fontSize         = 13
+fileBrowserGlob  = "{*,.tm_properties,.htaccess,}"
+excludeDirectories = "{node_modules,coverage,log,}"
+
+# Variables
+PATH             = "$PATH:$HOME/bin"
+TM_GIT           = "/opt/local/bin/git"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in {gemname}.gemspec
+gemspec

data/Makefile

@@ -0,0 +1,7 @@
+default: test
+
+test:
+	ruby lib/simple/immutable.rb
+
+release:
+	scripts/release.rb

data/README.md

@@ -0,0 +1,38 @@
+# simple-immutable
+
+Turns a nested data structure into a immutable ruby object implementing dot and [] accessors.
+
+## Usage
+
+
+    Immutable = ::Simple::Immutable
+
+    data =
+      {
+        a: "a-value",
+        "b": "b-value",
+        "child": {
+          name: "childname",
+          grandchild: {
+            name: "grandchildname"
+          }
+        },
+        "children": [
+          "anna",
+          "arthur",
+          {
+            action: {
+              keep_your_mouth_shut: true
+            }
+          }
+        ]
+      }
+      
+    imm = Immutable.create(data)
+    
+    imm.a # -> 'a-value'
+    imm.children.class                          # -> Array
+    imm.children[2].action.keep_your_mouth_shut # -> true
+    imm.children.foo                            # NoMethodError (undefined method `foo' for #<Array:0x00007fb90f1be390>)
+    imm.children.first.foo                      # NoMethodError (undefined method `foo' for "anna":String)
+

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/bin/bundle

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+    module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1 || ">= 0.a"
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||= begin
+      env_var_version || cli_arg_version ||
+        lockfile_version || "#{Gem::Requirement.default}.a"
+    end
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    # must dup string for RG < 1.8 compatibility
+    activate_bundler(bundler_version.dup)
+  end
+
+  def activate_bundler(bundler_version)
+    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
+      bundler_version = "< 2"
+    end
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_version
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+$: << "lib"
+require "simple/immutable"
+
+require "irb"
+require "irb/completion"
+
+IRB.start

data/lib/simple-immutable.rb

@@ -0,0 +1 @@
+require "simple/immutable"

data/lib/simple/immutable.rb

@@ -0,0 +1,148 @@
+module Simple
+end
+
+class Simple::Immutable
+  SELF = self
+
+  # turns an object, which can be a hash or array of hashes, arrays, and scalars
+  # into an object which you can use to access with dot methods.
+  def self.create(object, max_depth = 5)
+    case object
+    when Array
+      raise ArgumentError, "Object nested too deep (or inner loop?)" if max_depth < 0
+
+      object.map { |obj| create obj, max_depth - 1 }
+    when Hash
+      new(object)
+    else
+      object
+    end
+  end
+
+  private
+
+  def initialize(hsh)
+    @hsh = hsh
+  end
+
+  def method_missing(sym, *args, &block)
+    if args.empty? && !block
+      begin
+        value = @hsh.fetch(sym.to_sym) { @hsh.fetch(sym.to_s) }
+        return SELF.create(value)
+      rescue KeyError
+        # STDERR.puts "Missing attribute #{sym} for Immutable w/#{@hsh.inspect}"
+        nil
+      end
+    end
+
+    super
+  end
+
+  public
+
+  def respond_to_missing?(method_name, include_private = false)
+    @hsh.key?(method_name.to_sym) ||
+      @hsh.key?(method_name.to_s) ||
+      super
+  end
+
+  def inspect
+    "<Immutable: #{@hsh.inspect}>"
+  end
+
+  def respond_to?(sym)
+    super || @hsh.key?(sym.to_s) || @hsh.key?(sym.to_sym)
+  end
+
+  def ==(other)
+    @hsh == other
+  end
+end
+
+if $PROGRAM_NAME == __FILE__
+
+  # rubocop:disable Metrics/AbcSize
+
+  require "test-unit"
+
+  class Simple::Immutable::TestCase < Test::Unit::TestCase
+    Immutable = ::Simple::Immutable
+
+    def hsh
+      {
+        a: "a-value",
+        "b": "b-value",
+        "child": {
+          name: "childname",
+          grandchild: {
+            name: "grandchildname"
+          }
+        },
+        "children": [
+          "anna",
+          "arthur",
+          {
+            action: {
+              keep_your_mouth_shut: true
+            }
+          }
+        ]
+      }
+    end
+
+    def immutable
+      Immutable.create hsh
+    end
+
+    def test_hash_access
+      assert_equal "a-value", immutable.a
+      assert_equal "b-value", immutable.b
+    end
+
+    def test_comparison
+      immutable = Immutable.create hsh
+
+      assert_equal immutable, hsh
+      assert_not_equal({}, immutable)
+    end
+
+    def test_child_access
+      child = immutable.child
+      assert_kind_of(Immutable, child)
+      assert_equal "childname", immutable.child.name
+      assert_equal "grandchildname", immutable.child.grandchild.name
+    end
+
+    def test_array_access
+      assert_kind_of(Array, immutable.children)
+      assert_equal 3, immutable.children.length
+      assert_equal "anna", immutable.children[0]
+
+      assert_kind_of(Immutable, immutable.children[2])
+      assert_equal true, immutable.children[2].action.keep_your_mouth_shut
+    end
+
+    def test_base_class
+      assert_nothing_raised do
+        immutable.object_id
+      end
+    end
+
+    def test_missing_keys
+      assert_raise(NoMethodError) do
+        immutable.foo
+      end
+    end
+
+    def test_skip_when_args_or_block
+      assert_raise(NoMethodError) do
+        immutable.a(1, 2, 3)
+      end
+      assert_raise(NoMethodError) do
+        immutable.a { :dummy }
+      end
+    end
+  end
+
+end

data/scripts/release

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+$0.rb "$@"

data/scripts/release.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+# -- helpers ------------------------------------------------------------------
+
+def sys(cmd)
+  STDERR.puts "> #{cmd}"
+  system cmd
+  return true if $?.success?
+
+  STDERR.puts "> #{cmd} returned with exitstatus #{$?.exitstatus}"
+  $?.success?
+end
+
+def sys!(cmd, error: nil)
+  return true if sys(cmd)
+  STDERR.puts error if error
+  exit 1
+end
+
+def die!(msg)
+  STDERR.puts msg
+  exit 1
+end
+
+ROOT = File.expand_path("#{File.dirname(__FILE__)}/..")
+
+GEMSPEC = Dir.glob("*.gemspec").first || die!("Missing gemspec file.")
+
+# -- Version reading and bumping ----------------------------------------------
+
+module Version
+  extend self
+
+  VERSION_FILE = "#{Dir.getwd}/VERSION"
+
+  def read_version
+    version = File.exist?(VERSION_FILE) ? File.read(VERSION_FILE) : "0.0.1"
+    version.chomp!
+    raise "Invalid version number in #{VERSION_FILE}" unless version =~ /^\d+\.\d+\.\d+$/
+    version
+  end
+
+  def auto_version_bump
+    old_version_number = read_version
+    old = old_version_number.split('.')
+
+    current = old[0..-2] << old[-1].next
+    current.join('.')
+  end
+
+  def bump_version
+    next_version = ENV["VERSION"] || auto_version_bump
+    File.open(VERSION_FILE, "w") { |io| io.write next_version }
+  end
+end
+
+# -- check, bump, release a new gem version -----------------------------------
+
+Dir.chdir ROOT
+$BASE_BRANCH = ENV['BRANCH'] || 'master'
+
+# ENV["BUNDLE_GEMFILE"] = "#{Dir.getwd}/Gemfile"
+# sys! "bundle install"
+
+sys! "git diff --exit-code > /dev/null", error: 'There are unstaged changes in your working directory'
+sys! "git diff --cached --exit-code > /dev/null", error: 'There are staged but uncommitted changes'
+
+sys! "git checkout #{$BASE_BRANCH}"
+sys! "git pull"
+
+Version.bump_version
+version = Version.read_version
+
+sys! "git add VERSION"
+sys! "git commit -m \"bump gem to v#{version}\""
+sys! "git tag -a v#{version} -m \"Tag #{version}\""
+
+sys! "git push origin #{$BASE_BRANCH}"
+sys! 'git push --tags --force'
+
+sys! "gem build #{GEMSPEC}"
+sys! "mkdir -p pkg"
+sys! "mv *.gem pkg"
+
+gem_file = Dir.glob('pkg/*.gem').sort.last
+
+sys! "gem install #{gem_file}"
+sys! "gem push #{gem_file}"
+
+STDERR.puts <<-MSG
+================================================================================
+Thank you for releasing a new gem version. You made my day.
+================================================================================
+    MSG

data/simple-immutable.gemspec

@@ -0,0 +1,25 @@
+# This file is part of the sinatra-sse ruby gem.
+#
+# Copyright (c) 2016, 2017 @radiospiel, mediapeers Gem
+# Distributed under the terms of the modified BSD license, see LICENSE.BSD
+
+Gem::Specification.new do |gem|
+  gem.name     = "simple-immutable"
+  gem.version  = File.read "VERSION"
+
+  gem.authors  = [ "radiospiel", "mediapeers GmbH" ]
+  gem.email    = "eno@radiospiel.org"
+  gem.homepage = "http://github.com/radiospiel/simple-immutable"
+  gem.summary  = "Immutable ruby objects"
+
+  gem.description = "Immutable ruby objects implementing dot and [] accessors."
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths =  %w(lib)
+
+  # executables are used for development purposes only
+  gem.executables   = []
+
+  gem.required_ruby_version = '~> 2.3'
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: simple-immutable
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- radiospiel
+- mediapeers GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-03 00:00:00.000000000 Z
+dependencies: []
+description: Immutable ruby objects implementing dot and [] accessors.
+email: eno@radiospiel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".tm_properties"
+- Gemfile
+- Makefile
+- README.md
+- VERSION
+- bin/bundle
+- bin/console
+- lib/simple-immutable.rb
+- lib/simple/immutable.rb
+- scripts/release
+- scripts/release.rb
+- simple-immutable.gemspec
+homepage: http://github.com/radiospiel/simple-immutable
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Immutable ruby objects
+test_files: []