class2 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab6287d91741715040bde7550bf9a9a0de474d4b
-  data.tar.gz: 46e7ab44843d52de375a7a259f976e6c653e9d4a
+  metadata.gz: 7671575eba7274b6b325b522c133daeaf250f9ee
+  data.tar.gz: 9da2448df22a465c53201c23441a1142bc86d3bd
 SHA512:
-  metadata.gz: 19d653a1b5f20940ecf956f3952ebeabfcd8761e249b9fb136d34d30baf975f3a4db4ef124e982863f3157e6538b7ee2e5853e06b8113b3535a0183c311d4059
-  data.tar.gz: ad13a618934fc32fbe6ac72d8c0ee6645358d5d35df5b732217bb2c632abfba6a07eb957f43b2ee86ce549da890fcf99c82e17d7eb3f7ae9edd4dba183e7c73d
+  metadata.gz: 3aa91695a4eab4393fb211ec0d5582383e69e9e183728a532f4e5fe4c6d2f25d809f2e86e857299935ce5a216b790063dadb0281198a19c94952719b082cc901
+  data.tar.gz: be3aa3f33af4db98178ca53c056c143f1cfc5a3eef70d8d62ca49578c11beadf9d18212290f02e8571737d44f3f7647acba9afabf37c4a442326a014a2dffd82

data/Changes

@@ -1,3 +1,7 @@
+2017-09-14  v0.2.0
+--------------------
+* Add class2 method
+
 2017-08-15  v0.1.0
 --------------------
 * Add support for blocks

data/README.md

@@ -1,13 +1,13 @@
-# Class2
+# class2
 
-Easily create hierarchies of classes that support nested attributes, type conversion, equality, and more.
+Easily create class hierarchies that support nested attributes, type conversion, equality, and more.
 
 [![Build Status](https://travis-ci.org/sshaw/class2.svg?branch=master)](https://travis-ci.org/sshaw/class2)
 
 ## Usage
 
 ```rb
-Class2 :user => [
+class2 :user => [
          :name, :age,
          :addresses => [
            :city, :state, :zip,
@@ -22,12 +22,13 @@ This creates 3 classes: `User`, `Address`, and `Country` with the following attr
 * `Address`: city, state, zip, country
 * `Country`: name, code
 
-Each of these classes are created with [several additional methods](#methods).
 
-You can also specify types:
+Each of these classes are created with
+[several additional methods](#methods).  You can also specify types
+(or [namespaces](#namespaces)):
 
 ```rb
-Class2 :user => {
+class2 :user => {
          :name => String,
          :age  => Fixnum,
          :addresses => [
@@ -39,8 +40,8 @@ Class2 :user => {
          ]
        }
 ```
-An attempt is made to convert the attribute's type when a value is passed to the constructor
-or set via its accessor. Attributes without types are treated as is.
+
+Attributes without types are treated as is.
 
 After calling either one of the above you can do the following:
 
@@ -71,8 +72,8 @@ user.addresses << address
 User.new(:name => "sshaw") == User.new(:name => "sshaw")  # true
 ```
 
-`Class2` can create classes with typed attributes from example hashes.
-This makes it possible to build classes for things like API responses, using the API response
+`class2` can create classes with typed attributes from example hashes.
+This makes it possible to build classes for things like API responses using the API response
 itself as the specification:
 
 ```rb
@@ -94,14 +95,45 @@ response = [
   }
 ]
 
-Class2 :commit => response.first
+class2 :commit => response.first
 
 commit = Commit.new(response.first)
 commit.author.name    # "sshaw"
 commit.comment_count  # 0
 ```
 
-### Conversions
+### class2 API
+
+The are 3 ways to use class2. Pick the one that suites your style and/or requirements:
+
+* `class2()`
+* `Class2()`
+* `Class2.new`
+
+They all create classes the same way. They all return `nil`.
+
+To control the creation of the top-level methods, see the
+[`CLASS2_NO_EXPORT` environment variable](https://github.com/sshaw/class2/blob/a7ebe022b48db33d532cc483b0e036e4ec7d2e66/lib/class2.rb#L9-L23).
+
+#### Naming
+
+`class2` uses
+[`String#classify`](http://api.rubyonrails.org/classes/String.html#method-i-classify)
+to turn keys into class names: `:foo` will be `Foo`, `:foo_bars` will
+be `FooBar`.
+
+Plural keys with an array value are always assumed to be accessors for
+a collection and will default to returning an `Array`. `#classify` is
+used to derive the class names from the plural attribute names. An
+`:addresses` key with an `Array` value will result in a class named
+`Address` being created.
+
+Plurality is determined by [`String#pluralize`](http://api.rubyonrails.org/classes/String.html#method-i-pluralize).
+
+#### Conversions
+
+An attempt is made to convert the attribute's type when a value is passed to the constructor
+or set via its accessor.
 
 You can use any of these classes or their instances in your class definitions:
 
@@ -116,38 +148,25 @@ You can use any of these classes or their instances in your class definitions:
 Custom conversions are possible, just add the conversion to
 [`Class2::CONVERSIONS`](https://github.com/sshaw/class2/blob/517239afc76a4d80677e169958a1dc7836726659/lib/class2.rb#L14-L29)
 
-### Namespaces
+#### Namespaces
 
-`Class2` can use an exiting namespace or create a new one:
+`class2` can use an exiting namespace or create a new one:
 
 ```rb
-Class2 My::Namespace, :user => %i[name age]
+class2 My::Namespace,
+       :user => %i[name age]
 
 My::Namespace::User.new(:name => "sshaw")
 
-Class2 "New::Namespace", :user => %i[name age]
+class2 "New::Namespace",
+       :user => %i[name age]
 
 New::Namespace::User.new(:name => "sshaw")
 ```
 
-### Naming
-
-`Class2` uses
-[`String#classify`](http://api.rubyonrails.org/classes/String.html#method-i-classify)
-to turn keys into class names: `:foo` will be `Foo`, `:foo_bars` will
-be `FooBar`.
+#### Methods
 
-Plural keys with an array value are always assumed to be accessors for
-a collection and will default to returning an `Array`. `#classify` is
-used to derive the class names from the plural attribute names. An
-`:addresses` key with an `Array` value will result in a class named
-`Address` being created.
-
-Plurality is determined by [`String#pluralize`](http://api.rubyonrails.org/classes/String.html#method-i-pluralize).
-
-### Methods
-
-Classes created by `Class2` will have:
+Classes created by `class2` will have:
 
 * A constructor that accepts a nested attribute hash
 * Attribute readers and writers
@@ -155,28 +174,12 @@ Classes created by `Class2` will have:
 * `#eql?` and `#==`
 * `#hash`
 
-### Constructor
-
-The default constructor ignores unknown attributes.
-If you prefer to raise an exception include `Class2::StrictConstructor`:
-
-```rb
-Class2 :user => %w[id name age] do
-  include Class2::StrictConstructor
-end
-```
-
-Now an `ArgumentError` will be raised if anything but `id`, `name`, or
-`age` are passed in.
-
-Also see [Customizations](#customizations).
-
-### Customizations
+#### Customizations
 
 To add methods or include modules just open up the class and write or include them:
 
 ```rb
-Class2 :user => :name
+class2 :user => :name
 
 class User
   include SomeModule
@@ -189,11 +192,11 @@ end
 User.new(:name => "sshaw").first_initial
 ```
 
-`Class2` does accept a block whose contents will be added to
+`class2` does accept a block whose contents will be added to
 *every* class defined within the call:
 
 ```rb
-Class2 :user => :name, :address => :city do
+class2 :user => :name, :address => :city do
   include ActiveModel::Conversion
   extend ActiveModel::Naming
 end
@@ -202,6 +205,22 @@ User.new.model_name.route_key
 Address.new.model_name.route_key
 ```
 
+#### Constructor
+
+The default constructor ignores unknown attributes.
+If you prefer to raise an exception include `Class2::StrictConstructor`:
+
+```rb
+class2 :user => %w[id name age] do
+  include Class2::StrictConstructor
+end
+```
+
+Now an `ArgumentError` will be raised if anything but `id`, `name`, or
+`age` are passed in.
+
+Also see [Customizations](#customizations).
+
 ## See Also
 
 The Perl modules that served as inspiration:

data/lib/class2.rb

@@ -6,8 +6,20 @@ require "active_support/core_ext/string"
 
 require "class2/version"
 
-def Class2(*args, &block)
-  Class2.new(*args, &block)
+no_export = ENV["CLASS2_NO_EXPORT"]
+
+unless no_export == "1"
+  unless no_export == "Class2"
+    def Class2(*args, &block)
+      Class2.new(*args, &block)
+    end
+  end
+
+  unless no_export == "class2"
+    def class2(*args, &block)
+      Class2.new(*args, &block)
+    end
+  end
 end
 
 class Class2

data/lib/class2/version.rb

@@ -1,3 +1,3 @@
 class Class2
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: class2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Skye Shaw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Easily create hierarchies of classes that support nested attributes, type