ure 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07b4b26f3281fc716ce5068916f52bb219e9b1bb
-  data.tar.gz: 96ac0815b786b4fbf623d57952668397835b4545
+  metadata.gz: 2f3cf82f8e01a109b41d7a8ff69063061ed0ccec
+  data.tar.gz: 373bf2711371e35ea41d317dac7601670e047f82
 SHA512:
-  metadata.gz: 32b40cb6ef7961271d12140c9d560ab3ec10c44c0d201f322f0dd607e4cb2a2b7be4d4b8d421e3a04b914f97d4aa0b940569fa9926d8d199d387f193e4984f94
-  data.tar.gz: 2f3b0346f8a25aa39bccff9b5607c0dae6ae78f0ed497138512aa9ed311c91c09d840b73f0c036999ef928394d63a3335477a4641a9f3003e01daa5d92d807ec
+  metadata.gz: 8f4c9ab56fa34c705fbe6a853539102955a105d1724e9dc9efbd46ffe4cdb91b4c9ea018006b14f26e2eb98116001e03e64378e3d3d89d80716e9577be623e62
+  data.tar.gz: 4f1eeb24299b2249f093cdde3dbe44202f5fa35bfb79716d3f67d7b1f6ab334eade4086d7b0c82ce30a498f9bb215696738878b29734df17dd7b78801e062f0c

data/CODE_OF_CONDUCT.md

@@ -1,13 +1,50 @@
 # Contributor Code of Conduct
 
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+As contributors and maintainers of this project, and in the interest of  
+fostering an open and welcoming community, we pledge to respect all people who  
+contribute through reporting issues, posting feature requests, updating  
+documentation, submitting pull requests or patches, and other activities.
 
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+We are committed to making participation in this project a harassment-free  
+experience for everyone, regardless of level of experience, gender, gender  
+identity and expression, sexual orientation, disability, personal appearance,  
+body size, race, ethnicity, age, religion, or nationality.
 
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+Examples of unacceptable behavior by participants include:
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+* The use of sexualized language or imagery  
+* Personal attacks  
+* Trolling or insulting/derogatory comments  
+* Public or private harassment  
+* Publishing other's private information, such as physical or electronic  
+  addresses, without explicit permission  
+* Other unethical or unprofessional conduct
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+Project maintainers have the right and responsibility to remove, edit, or  
+reject comments, commits, code, wiki edits, issues, and other contributions  
+that are not aligned to this Code of Conduct, or to ban temporarily or  
+permanently any contributor for other behaviors that they deem inappropriate,  
+threatening, offensive, or harmful.
 
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
+By adopting this Code of Conduct, project maintainers commit themselves to  
+fairly and consistently applying these principles to every aspect of managing  
+this project. Project maintainers who do not follow or enforce the Code of  
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces  
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be  
+reported by contacting a project maintainer at claytonflesher@gmail.com. All  
+complaints will be reviewed and investigated and will result in a response that  
+is deemed necessary and appropriate to the circumstances. Maintainers are  
+obligated to maintain confidentiality with regard to the reporter of an  
+incident.  
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],  
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -108,7 +108,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Calvyn82/ure. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Calvyn82/ure. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](CODE_OF_CONDUCT.md) code of conduct.
 
 
 ## License

data/lib/ure.rb

@@ -1,11 +1,18 @@
 require "ure/version"
 require "json"
+##
+# Immutable alternative to Struct that requires keyword arguments
 class Ure < BasicObject
   include ::Enumerable
+
+  ##
+  # Returns the ure members as an array of symbols.
   def self.members
     @members.freeze
   end
 
+  ##
+  # Create an ure named by its constant.
   def self.new(*members, &body)
     ::Class.new(self) do
       instance_variable_set(:@members, members)
@@ -58,6 +65,8 @@ class Ure < BasicObject
 
   attr_reader :fields
 
+  ##
+  # Equality---Returns true if other has the same ure subclass and has equal member values.
   def ==(arg)
     if self.class == arg.class
       fields == arg.fields
@@ -68,38 +77,56 @@ class Ure < BasicObject
     false
   end
 
+  ##
+  # Because Ure doesn't care about indexing, this allows users to treat instances of Ure as a hash.
   def [](key)
     fields[key]
   end
 
+  ##
+  # Converts the fields into a hash and calls each on them.
   def each(&block)
     to_h.each(&block)
   end
 
+  ##
+  # Returns a string describing the object and its fields
   def to_s
     "#<#{::Ure} #{self.class} #{fields.to_s}"
   end
 
+  ##
+  # Returns a string describing the object and its fields
   def inspect
     "#<#{::Ure} #{self.class} #{fields.to_s}"
   end
 
+  ##
+  # Alias for #values
   def to_a
     fields.values
   end
 
+  ##
+  # Alias for #fields
   def to_h
     fields.to_h
   end
 
+  ##
+  # Returns an array of the values in the fields
   def values
     fields.values
   end
 
+  ##
+  # Takes one or more keys as arguments, and returns an array of the corresponding values.
   def values_at(name, *args)
     [fields[name]] + args.map { |arg| fields[arg] }
   end
 
+  ##
+  # Returns a JSON string of members and values.
   def to_json
     fields.to_json
   end

data/lib/ure/version.rb

@@ -1,3 +1,3 @@
 class Ure < BasicObject
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ure
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Clayton Flesher
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler