crstruct 0.1.191207 → 0.1.210920

checksums.yaml

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

data/README.md

@@ -1,5 +1,6 @@
 # crstruct
 
+* [VERSION 0.1.210920](https://www.github.com/carlosjhr64/crstruct/releases)
 * [github](https://www.github.com/carlosjhr64/crstruct)
 * [rubygems](https://rubygems.org/gems/crstruct)
 
@@ -13,97 +14,74 @@ 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
+  # as there's no actual s.a=...
+rescue NoMethodError
+  s.b = "B"
+end
+s.a #=> "A"
+s.b #=> "B"
+
+if s.b == "B"
+  begin
+    s.c # There is no s.c so raises
+  rescue NoMethodError
+    s.c = "C"
+  end
+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
-  
-
+```ruby
+s = CRStruct::Registered.new :a, :b, :c
+s.a = "A"
+s.b = "B"
+s.c = "C"
+begin
+  s.d = "D"
+rescue NoMethodError
+  # Can't set :d as it was not registered with s.
+end
+s
+#~> ^#<CRStruct::Registered:0x\h+ @r=\[:a, :b, :c\], @h=\{:a=>"A", :b=>"B", :c=>"C"\}>$
+```
 ## 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::Open.new a: "A", b: "B"
+s.get?(:c)      #=> nil
+s.set!(:c, "C")
+s.get?(:c)      #=> "C"
+s.c             #=> "C"
+
+# The :free? method determines if a Symbol is available for setting.
+s.free?(:to_s) #=> false
+s.free?(:d)    #=> true
+```
 ## LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2019 CarlosJHR64
+Copyright (c) 2021 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/open.rb

@@ -16,7 +16,7 @@ module CRStruct
 
     #########################################
     ### free?, set!, and get? ###
-    # make purposefull access to @h possible,
+    # make purposeful access to @h possible,
     # and easier to subclass CRStruct.
     #########################################
 
@@ -46,4 +46,3 @@ module CRStruct
     end
   end
 end
-

data/lib/crstruct/registered.rb

@@ -20,4 +20,3 @@ module CRStruct
     end
   end
 end
-

data/lib/crstruct.rb

@@ -1,6 +1,6 @@
 module CRStruct
-  VERSION = '0.1.191207'
-  require 'crstruct/open'
+  VERSION = '0.1.210920'
+  require_relative 'crstruct/open'
   autoload :Registered, 'crstruct/registered'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crstruct
 version: !ruby/object:Gem::Version
-  version: 0.1.191207
+  version: 0.1.210920
 platform: ruby
 authors:
-- carlosjhr64
-autorequire: 
+- CarlosJHR64
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-07 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies: []
 description: |
   Ruby gem for an extremely lite OpenStruct like class with
@@ -30,7 +30,7 @@ homepage: https://github.com/carlosjhr64/crstruct
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -45,9 +45,9 @@ 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
-signing_key: 
+- 'ruby: ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux]'
+rubygems_version: 3.2.22
+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.