ztk 1.4.4 → 1.4.5

data/lib/ztk/config.rb

@@ -1,29 +1,10 @@
-################################################################################
-#
-#      Author: Zachary Patten <zachary@jovelabs.net>
-#   Copyright: Copyright (c) Zachary Patten
-#     License: Apache License, Version 2.0
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-################################################################################
 require 'ostruct'
 
 module ZTK
 
-  # ZTK::Config General Error Class
+  # Config Error Class
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class ConfigError < Error; end
 
   # Configuration Module
@@ -62,7 +43,7 @@ module ZTK
   #
   #     puts C.message
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   module Config
 
     # Extend base class with this module.

data/lib/ztk/dsl.rb

@@ -1,33 +1,14 @@
-################################################################################
-#
-#      Author: Zachary Patten <zachary@jovelabs.net>
-#   Copyright: Copyright (c) Zachary Patten
-#     License: Apache License, Version 2.0
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-################################################################################
-require "active_support/inflector"
+require 'active_support/inflector'
 
 module ZTK
 
   # Generic Domain-specific Language Interface
   #
   # @see ZTK::DSL::Base
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   module DSL
 
-    # @author Zachary Patten <zachary@jovelabs.net>
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
     class DSLError < Error; end
 
     autoload :Base, "ztk/dsl/base"

data/lib/ztk/dsl/base.rb

@@ -1,23 +1,3 @@
-################################################################################
-#
-#      Author: Zachary Patten <zachary@jovelabs.net>
-#   Copyright: Copyright (c) Zachary Patten
-#     License: Apache License, Version 2.0
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-################################################################################
-
 module ZTK::DSL
 
   # Generic Domain-specific Language Interface
@@ -148,7 +128,7 @@ module ZTK::DSL
   #     [9] pry(main)> Server.find(:my_server)
   #     => [#<Server id=:my_server attributes={:id=>:my_server, :name=>"my-server", :network_id=>:leet_net}, belongs_to_references=1>]
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class Base
     include(ZTK::DSL::Core)
 
@@ -184,6 +164,12 @@ module ZTK::DSL
       raise StandardError, "Primary key '#{self.id}' already exists!" if (primary_key_count > 1)
     end
 
+    # Instance Inspect
+    #
+    # Inspect the DSL object's instance, returning a concise string
+    # representation of the instance.
+    #
+    # @return [String] A concise string representation of the instance.
     def inspect
       details = Array.new
       details << "attributes=#{attributes.inspect}" if attributes.count > 0
@@ -192,9 +178,15 @@ module ZTK::DSL
       "#<#{self.class.to_s} id=#{self.id.inspect} #{details.join(', ')}>"
     end
 
-    # @author Zachary Patten <zachary@jovelabs.net>
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
     module ClassMethods
 
+      # Class Inspect
+      #
+      # Inspect the DSL object's class, returning a concise string
+      # representation of the class.
+      #
+      # @return [String] A concise string representation of the class.
       def inspect
         details = Array.new
         details << "count=#{self.all.count}" if self.all.count > 0

data/lib/ztk/dsl/core.rb

@@ -1,28 +1,8 @@
-################################################################################
-#
-#      Author: Zachary Patten <zachary@jovelabs.net>
-#   Copyright: Copyright (c) Zachary Patten
-#     License: Apache License, Version 2.0
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-################################################################################
-
 module ZTK::DSL
 
-  # ZTK::DSL Core
+  # DSL Core
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   # @api private
   module Core
     autoload :Attributes, "ztk/dsl/core/attributes"
@@ -46,7 +26,7 @@ module ZTK::DSL
       end
     end
 
-    # @author Zachary Patten <zachary@jovelabs.net>
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
     # module DualMethods
 
     #   def logger
@@ -61,7 +41,7 @@ module ZTK::DSL
 
     # end
 
-    # @author Zachary Patten <zachary@jovelabs.net>
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
     module ClassMethods
 
       def cattr_accessor(*args)

data/lib/ztk/dsl/core/actions.rb

@@ -1,26 +1,6 @@
-################################################################################
-#
-#      Author: Zachary Patten <zachary@jovelabs.net>
-#   Copyright: Copyright (c) Zachary Patten
-#     License: Apache License, Version 2.0
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-################################################################################
-
 module ZTK::DSL::Core
 
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   # @api private
   module Actions
     autoload :Find, "ztk/dsl/core/actions/find"

data/lib/ztk/dsl/core/actions/find.rb

@@ -1,26 +1,6 @@
-################################################################################
-#
-#      Author: Zachary Patten <zachary@jovelabs.net>
-#   Copyright: Copyright (c) Zachary Patten
-#     License: Apache License, Version 2.0
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-################################################################################
-
 module ZTK::DSL::Core::Actions
 
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   # @api private
   module Find
 
@@ -30,7 +10,7 @@ module ZTK::DSL::Core::Actions
       end
     end
 
-    # @author Zachary Patten <zachary@jovelabs.net>
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
     module ClassMethods
 
       def all

data/lib/ztk/dsl/core/actions/timestamps.rb

@@ -1,26 +1,6 @@
-################################################################################
-#
-#      Author: Zachary Patten <zachary@jovelabs.net>
-#   Copyright: Copyright (c) Zachary Patten
-#     License: Apache License, Version 2.0
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-################################################################################
-
 module ZTK::DSL::Core::Actions
 
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   # @api private
   module Timestamps
 
@@ -34,7 +14,7 @@ module ZTK::DSL::Core::Actions
       end
     end
 
-    # @author Zachary Patten <zachary@jovelabs.net>
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
     module ClassMethods
 
       def updated_at_timestamp

data/lib/ztk/dsl/core/attributes.rb

@@ -1,26 +1,6 @@
-################################################################################
-#
-#      Author: Zachary Patten <zachary@jovelabs.net>
-#   Copyright: Copyright (c) Zachary Patten
-#     License: Apache License, Version 2.0
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-################################################################################
-
 module ZTK::DSL::Core
 
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   # @api private
   module Attributes
 
@@ -34,7 +14,7 @@ module ZTK::DSL::Core
       @attributes ||= {}
     end
 
-    # @author Zachary Patten <zachary@jovelabs.net>
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
     module ClassMethods
 
       def attribute(key, options={})

data/lib/ztk/dsl/core/dataset.rb

@@ -1,26 +1,6 @@
-################################################################################
-#
-#      Author: Zachary Patten <zachary@jovelabs.net>
-#   Copyright: Copyright (c) Zachary Patten
-#     License: Apache License, Version 2.0
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-################################################################################
-
 module ZTK::DSL::Core
 
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   # @api private
   module Dataset
 
@@ -30,7 +10,7 @@ module ZTK::DSL::Core
       end
     end
 
-    # @author Zachary Patten <zachary@jovelabs.net>
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
     module ClassMethods
 
       def dataset

data/lib/ztk/dsl/core/io.rb

@@ -1,26 +1,6 @@
-################################################################################
-#
-#      Author: Zachary Patten <zachary@jovelabs.net>
-#   Copyright: Copyright (c) Zachary Patten
-#     License: Apache License, Version 2.0
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-################################################################################
-
 module ZTK::DSL::Core
 
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   # @api private
   module IO
 
@@ -30,7 +10,7 @@ module ZTK::DSL::Core
       end
     end
 
-    # @author Zachary Patten <zachary@jovelabs.net>
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
     module ClassMethods
 
       def load(rb_file)

data/lib/ztk/dsl/core/relations.rb

@@ -1,26 +1,6 @@
-################################################################################
-#
-#      Author: Zachary Patten <zachary@jovelabs.net>
-#   Copyright: Copyright (c) Zachary Patten
-#     License: Apache License, Version 2.0
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-################################################################################
-
 module ZTK::DSL::Core
 
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   # @api private
   module Relations
     autoload :BelongsTo, "ztk/dsl/core/relations/belongs_to"
@@ -34,7 +14,7 @@ module ZTK::DSL::Core
       end
     end
 
-    # @author Zachary Patten <zachary@jovelabs.net>
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
     module ClassMethods
 
       def add_relation(key)

data/lib/ztk/dsl/core/relations/belongs_to.rb

@@ -1,26 +1,6 @@
-################################################################################
-#
-#      Author: Zachary Patten <zachary@jovelabs.net>
-#   Copyright: Copyright (c) Zachary Patten
-#     License: Apache License, Version 2.0
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-################################################################################
-
 module ZTK::DSL::Core::Relations
 
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   # @api private
   module BelongsTo
 
@@ -64,7 +44,7 @@ module ZTK::DSL::Core::Relations
       end
     end
 
-    # @author Zachary Patten <zachary@jovelabs.net>
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
     module ClassMethods
 
       def belongs_to(key, options={})