crstruct 0.1.191207

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 209a6ae14aeccf1e9a288b8cff5bc23d087db926e8b70bfb56a80584f91bd213
+  data.tar.gz: d831dbb9f99e53fbc4108ed912f03f6c183504a9f6b4db55a774dbc5d3f88bf8
+SHA512:
+  metadata.gz: bb1664c894671291901cb2fde5045a617f8f36c279a688fc424cfbaff99210bdd53eb2cfb8654ed7494c65f8ab97ed7ffe367f1958e127388dee3d44fcded021
+  data.tar.gz: 6382accd098940a5f62f18e8e00491941cc206abd6379532442edd24c3dca926ac83f6dd521f2227dab361291372d5777dc95c1d8924a75f959a65325acef3c3

data/README.md

@@ -0,0 +1,125 @@
+# crstruct
+
+* [github](https://www.github.com/carlosjhr64/crstruct)
+* [rubygems](https://rubygems.org/gems/crstruct)
+
+## DESCRIPTION
+
+Ruby gem for an extremely lite OpenStruct like class with
+attributes that can only be set once, and then read thereafter.
+
+The "CR" in `CRStruct` is for "Create and Read"...
+no "Update"...
+no "Delete".
+
+## INSTALL:
+
+    gem install crstruct
+
+## SYNOPSIS
+
+The following shows the intended use of CRStruct::Open:
+
+    require 'crstruct'
+    
+    s = CRStruct::Open.new
+    s.a = "A" #=> "A"
+    
+    begin
+      # Not allowed to reset s.a...
+      s.a = "B"
+      # as there's no actual s.a=...
+    rescue NoMethodError
+      s.b = "B" #=> "B"
+    end
+    
+    if s.b == "B" #=> true
+      begin
+        # There is no s.c...
+        puts "s.c is #{s.c}"
+      rescue NoMethodError
+        s.c = "C" #=> "C"
+        # Output:
+        #   s.a is A
+        #   s.b is B
+        #   s.c is C
+        puts "s.a is #{s.a}"
+        puts "s.b is #{s.b}"
+        puts "s.c is #{s.c}"
+      end
+    end
+
+There's also a subclass CRStruct::Registered:
+
+    require 'crstruct'
+    
+    s = CRStruct::Registered.new :a, :b, :c
+    s.a = "A" #=> "A"
+    s.b = "B" #=> "B"
+    s.c = "C" #=> "C"
+    begin
+      s.d = "D"
+    rescue NoMethodError
+      # Can't set :d as it was not registered with s.
+    end
+    # Output:
+    #  #<CRStruct::Registered:0x0000561d37006b08
+    #   @h={:a=>"A", :b=>"B", :c=>"C"},
+    #   @r=[:a, :b, :c]>
+    pp s
+  
+
+## MORE
+
+The following can be done, but
+you'd be circumventing the intended use:
+
+    require 'crstruct'
+    
+    s = CRStruct::Open.new a: "A", b: "B"
+    s.set!(:c, "C") #=> "C"
+    
+    # s' internal hash does not have :d
+    if s.get?(:d).nil?
+      # Output:
+      #   s.a is A
+      #   s.b is B
+      #   s.c is C
+      #   s.d is nil
+      puts "s.a is #{s.get?(:a)}"
+      puts "s.b is #{s.get?(:b)}"
+      puts "s.c is #{s.get?(:c)}"
+      puts "s.d is #{s.get?(:d)}"
+      # Output:
+      #   {:a=>"A", :b=>"B", :c=>"C"}
+      pp s.to_h
+    end
+    
+    # The :free? method determines if a Symbol is avaible for setting.
+    s.free?(:to_s) #=> false
+    s.free?(:d) #=> true
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2019 CarlosJHR64
+
+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/lib/crstruct.rb

@@ -0,0 +1,8 @@
+module CRStruct
+  VERSION = '0.1.191207'
+  require 'crstruct/open'
+  autoload :Registered, 'crstruct/registered'
+end
+
+# Requires:
+#`ruby`

data/lib/crstruct/open.rb

@@ -0,0 +1,49 @@
+module CRStruct
+  class Open
+    ### h should support interface ###
+    # raise "need Hash(Symbol,Value)" unless
+    #   [:to_h, :keys, :has_key?, :[], :[]=].all?{|_|h.respond_to?_} and
+    #   h.keys.all?{|_|_.is_a? Symbol}
+    def initialize(h={})
+      @h = h
+    end
+
+    # Can it somehow be converted into a Hash?
+    # Most likely.
+    def to_h
+      @h.to_h
+    end
+
+    #########################################
+    ### free?, set!, and get? ###
+    # make purposefull access to @h possible,
+    # and easier to subclass CRStruct.
+    #########################################
+
+    def free?(k)
+      !(@h.has_key?(k) or respond_to?(k))
+    end
+    def set!(k, v)
+      @h[k]=v
+    end
+    def get?(k)
+      @h[k]
+    end
+
+    def method_missing(key, *args, &proc)
+      if proc.nil?
+        case args.length
+        when 0
+          return get?(key) if @h.has_key? key
+        when 1
+          if key=~/^\w+=$/
+            k = key[0..-2].to_sym
+            return set!(k, args[0]) if free?(k)
+          end
+        end
+      end
+      super
+    end
+  end
+end
+

data/lib/crstruct/registered.rb

@@ -0,0 +1,23 @@
+module CRStruct
+  class Registered < Open
+    # Registered.new :a, :b, :c, :d
+    # Registered.new {a: 1, b: 2}, :c, :d
+    # Registered.new {a: 1, b: 2}, [:c, :d]
+    # (*keys).flatten! should result to an Array(Symbol)
+    def initialize(h, *keys)
+      keys.flatten!
+      if h.is_a? Symbol
+        keys.unshift(h)
+        h = {}
+      end
+      @r = keys
+      super(h)
+    end
+
+    def free?(k)
+      return false unless @r.include? k
+      super(k)
+    end
+  end
+end
+

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: crstruct
+version: !ruby/object:Gem::Version
+  version: 0.1.191207
+platform: ruby
+authors:
+- carlosjhr64
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-07 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Ruby gem for an extremely lite OpenStruct like class with
+  attributes that can only be set once, and then read thereafter.
+
+  The "CR" in `CRStruct` is for "Create and Read"...
+  no "Update"...
+  no "Delete".
+email: carlosjhr64@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/crstruct.rb
+- lib/crstruct/open.rb
+- lib/crstruct/registered.rb
+homepage: https://github.com/carlosjhr64/crstruct
+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:
+- 'ruby: ruby 2.6.5p114 (2019-10-01 revision 67812) [x86_64-linux]'
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby gem for an extremely lite OpenStruct like class with attributes that
+  can only be set once, and then read thereafter.
+test_files: []