crstruct 0.1.191207 → 1.0.221218

checksums.yaml

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

data/README.md

@@ -1,5 +1,6 @@
-# crstruct
+# CRStruct
 
+* [VERSION 1.0.221218](https://www.github.com/carlosjhr64/crstruct/releases)
 * [github](https://www.github.com/carlosjhr64/crstruct)
 * [rubygems](https://rubygems.org/gems/crstruct)
 
@@ -9,101 +10,60 @@ 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".
+No "Update"...
+No "Delete".
 
 ## INSTALL:
-
-    gem install crstruct
-
+```console
+$ 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
-
+```ruby
+require 'crstruct'
+
+s = CRStruct::Open.new
+s.a = "A"
+s.a #=> "A"
+
+begin
+  # Not allowed to reset s.a...
+  s.a = "B" # raises error
+rescue FrozenError
+  s.b = "B"
+end
+s.a #=> "A"
+s.b #=> "B"
+
+begin
+  s.c # There is no s.c so raises
+rescue NoMethodError
+  s.c = "C"
+end
+s.a #=> "A"
+s.b #=> "B"
+s.c #=> "C"
+```
 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
-
+```ruby
+s = CRStruct::Registered.new :a, :b, :c
+s.a = "A"
+s.b = "B"
+s.c = "C"
+begin
+  s.d = "D"
+rescue KeyError
+  # Can't set :d as it was not registered with s.
+end
+s
+#~> ^#<CRStruct::Registered:0x\h+ @keys=\[:a, :b, :c\]>$
+```
 ## LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2019 CarlosJHR64
+Copyright (c) 2022 CarlosJHR64
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/crstruct.rb

@@ -1,7 +1,24 @@
 module CRStruct
-  VERSION = '0.1.191207'
-  require 'crstruct/open'
-  autoload :Registered, 'crstruct/registered'
+  VERSION = '1.0.221218'
+  class Open
+    def method_missing(key, *args, &blk)
+      super unless blk.nil? and key[-1]=='=' and args.length==1
+      k,v = key[0..-2].to_sym,args[0]
+      raise FrozenError, "can't modify CRStruct method: :#{k}" if respond_to? k
+      define_singleton_method(k){v}
+    end
+  end
+
+  class Registered < Open
+    def initialize(*keys)
+      @keys = keys
+    end
+
+    def define_singleton_method(k,&blk)
+      raise KeyError, "can't add unregistered key: :#{k}" unless @keys.include? k
+      super(k,&blk)
+    end
+  end
 end
 
 # Requires:

metadata

@@ -1,22 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: crstruct
 version: !ruby/object:Gem::Version
-  version: 0.1.191207
+  version: 1.0.221218
 platform: ruby
 authors:
-- carlosjhr64
+- CarlosJHR64
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-07 00:00:00.000000000 Z
+date: 2022-12-18 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".
+  No "Update"...
+  No "Delete".
 email: carlosjhr64@gmail.com
 executables: []
 extensions: []
@@ -24,8 +24,6 @@ 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
@@ -45,8 +43,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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
+- 'ruby: ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [aarch64-linux]'
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Ruby gem for an extremely lite OpenStruct like class with attributes that

data/lib/crstruct/open.rb

@@ -1,49 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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
-