bronze 0.0.1.alpha → 0.1.0

data/lib/bronze/transforms/attributes/date_transform.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'date'
+
+require 'bronze/transform'
+require 'bronze/transforms/attributes'
+
+module Bronze::Transforms::Attributes
+  # Transform class that normalizes a Date to a formatted string representation.
+  class DateTransform < Bronze::Transform
+    # Format string for ISO 8601 date format. Equivalent to YYYY-MM-DD.
+    ISO_8601 = '%F'
+
+    # @return [DateTransform] a memoized instance of DateTransform.
+    def self.instance
+      @instance ||= new
+    end
+
+    # @param format [String] The format string used to normalize and denormalize
+    #   dates. The default is ISO 8601 format.
+    def initialize(format = ISO_8601)
+      @format = format
+    end
+
+    # @return [String] the format string.
+    attr_reader :format
+
+    # Converts a formatted Date string to a Date instance.
+    #
+    # @param value [String] The normalized string.
+    #
+    # @return [Date] the parsed date.
+    def denormalize(value)
+      return value if value.is_a?(Date)
+
+      return nil if value.nil? || value.empty?
+
+      Date.strptime(value, read_format)
+    end
+
+    # Converts a Date to a formatted string.
+    #
+    # @param value [Date] The Date to format.
+    #
+    # @return [String] the formatted string.
+    def normalize(value)
+      return nil if value.nil?
+
+      value.strftime(format)
+    end
+
+    private
+
+    def read_format
+      @read_format ||= format.gsub('%-', '%')
+    end
+  end
+end

data/lib/bronze/transforms/attributes/symbol_transform.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'bronze/transform'
+require 'bronze/transforms/attributes'
+
+module Bronze::Transforms::Attributes
+  # Transform class that converts a Symbol to a string.
+  class SymbolTransform < Bronze::Transform
+    # @return [SymbolTransform] a memoized instance of SymbolTransform.
+    def self.instance
+      @instance ||= new
+    end
+
+    # Converts a normalized String to a Symbol.
+    #
+    # @param value [String] The normalized string.
+    #
+    # @return [Symbol] the denormalized symbol.
+    def denormalize(value)
+      return nil if value.nil?
+
+      value.intern
+    end
+
+    # Converts a Symbol to a string.
+    #
+    # @param value [Symbol] The Symbol to normalize.
+    #
+    # @return [String] the string representation.
+    def normalize(value)
+      return nil if value.nil?
+
+      value.to_s
+    end
+  end
+end

data/lib/bronze/transforms/attributes/time_transform.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'date'
+
+require 'bronze/transform'
+require 'bronze/transforms/attributes'
+
+module Bronze::Transforms::Attributes
+  # Transform class that converts a Time to an integer timestamp.
+  class TimeTransform < Bronze::Transform
+    # @return [TimeTransform] a memoized instance of TimeTransform.
+    def self.instance
+      @instance ||= new
+    end
+
+    # Converts an integer timestamp to a Time.
+    #
+    # @param value [Integer] The integer timestamp.
+    #
+    # @return [Time] the Time corresponding to the timestamp.
+    def denormalize(value)
+      return nil if value.nil?
+
+      Time.at(value).utc
+    end
+
+    # Converts a Time to an integer timestamp.
+    #
+    # @param value [Time] The Time to normalize.
+    #
+    # @return [Integer] the integer timestamp.
+    def normalize(value)
+      return nil if value.nil?
+
+      value.to_i
+    end
+  end
+end

data/lib/bronze/transforms/entities.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'bronze/transforms'
+
+module Bronze::Transforms
+  # Namespace for defining entity transforms, which convert entities to a
+  # normalized form
+  module Entities; end
+end

data/lib/bronze/transforms/entities/normalize_transform.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'bronze/transform'
+require 'bronze/transforms/entities'
+
+module Bronze::Transforms::Entities
+  # Transform class that maps an entity to a normal representation.
+  class NormalizeTransform < Bronze::Transform
+    # @param [Class] entity_class The entity class to normalize.
+    # @param [Array<Class>] permit An optional array of types to normalize
+    #   as-is, rather than applying a transform. Only default transforms can be
+    #   permitted, i.e. the built-in default transforms for BigDecimal, Date,
+    #   DateTime, Symbol, and Time, or for an attribute with the
+    #   :default_transform flag set to true.
+    def initialize(entity_class, permit: [])
+      @entity_class    = entity_class
+      @permitted_types = permit
+    end
+
+    # @return [Class] the entity class to normalize.
+    attr_reader :entity_class
+
+    # @return [Array<Class>] array of types to normalize as-is.
+    attr_reader :permitted_types
+
+    # Returns an entity instance.
+    #
+    # @param attributes [Hash] The normal representation of an entity.
+    #
+    # @return [Bronze::Entity] the entity instance.
+    #
+    # @see [Bronze::Entities::Normalization::denormalize]
+    def denormalize(attributes)
+      return nil if attributes.nil?
+
+      entity_class.denormalize(attributes)
+    end
+
+    # Returns a normalized representation of the entity.
+    #
+    # @param entity [Bronze::Entity] The entity to normalize.
+    #
+    # @return [Hash] the normal representation.
+    #
+    # @see [Bronze::Entities::Normalization#normalize]
+    def normalize(entity)
+      return nil if entity.nil?
+
+      entity.normalize(permit: permitted_types)
+    end
+  end
+end

data/lib/bronze/transforms/identity_transform.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'bronze/transform'
+
+module Bronze::Transforms
+  # Transform class that maps an object to itself.
+  class IdentityTransform < Bronze::Transform
+    # @return [IdentityTransform] a memoized instance of IdentityTransform.
+    def self.instance
+      @instance ||= new
+    end
+
+    # Returns the object that was passed in to the method.
+    #
+    # @param object [Object] The object to denormalize.
+    #
+    # @return [Object] the object passed in.
+    def denormalize(object)
+      object
+    end
+
+    # Returns the object that was passed in to the method.
+    #
+    # @param object [Object] The object to normalize.
+    #
+    # @return [Object] the object passed in.
+    def normalize(object)
+      object
+    end
+  end
+end

data/lib/bronze/version.rb

@@ -1,4 +1,4 @@
-# lib/bronze/version.rb
+# frozen_string_literal: true
 
 module Bronze
   # @api private
@@ -10,11 +10,11 @@ module Bronze
     # Major version.
     MAJOR = 0
     # Minor version.
-    MINOR = 0
+    MINOR = 1
     # Patch version.
-    PATCH = 1
+    PATCH = 0
     # Prerelease version.
-    PRERELEASE = :alpha
+    PRERELEASE = nil
     # Build metadata.
     BUILD = nil
 
@@ -27,7 +27,7 @@ module Bronze
       #
       # @see SleepingKingStudios::Tools::SemanticVersion#to_gem_version
       def to_gem_version
-        str = "#{MAJOR}.#{MINOR}.#{PATCH}"
+        str = +"#{MAJOR}.#{MINOR}.#{PATCH}"
 
         prerelease = value_of(:PRERELEASE)
         str << ".#{prerelease}" if prerelease
@@ -36,11 +36,11 @@ module Bronze
         str << ".#{build}" if build
 
         str
-      end # class method to_version
+      end
 
       private
 
-      def value_of constant
+      def value_of(constant)
         return nil unless const_defined?(constant)
 
         value = const_get(constant)
@@ -48,9 +48,10 @@ module Bronze
         return nil if value.respond_to?(:empty?) && value.empty?
 
         value
-      end # method value_of
-    end # eigenclass
-  end # module
+      end
+    end
+  end
 
+  # The current version of the gem.
   VERSION = Version.to_gem_version
-end # module
+end

metadata

@@ -1,144 +1,174 @@
 --- !ruby/object:Gem::Specification
 name: bronze
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.1.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sysrandom
+  name: sleeping_king_studios-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
-  name: sleeping_king_studios-tools
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
-  type: :runtime
+        version: '3.8'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: rspec-sleeping_king_studios
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 0.63.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.63.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 0.63.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.63.1
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.43'
+        version: 1.32.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.43'
+        version: 1.32.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
-  name: rspec-sleeping_king_studios
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0.20'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 0.20.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0.20'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
-description: A set of objects and tools for building composable applications without
-  the conceptual overhead of common frameworks. Allows the developer to incorporate
-  other architectures by composition without forcing foreign constraints on your business
-  logic.
+        version: 0.20.3
+description: |-
+  A composable application toolkit, providing data entities and collections,
+  transforms, contract-based validations and pre-built operations.
+  Architecture agnostic for easy integration with other toolkits or
+  frameworks.
 email:
 - merlin@sleepingkingstudios.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- DEVELOPMENT.md
 - LICENSE
 - README.md
 - lib/bronze.rb
+- lib/bronze/entities.rb
+- lib/bronze/entities/attributes.rb
+- lib/bronze/entities/attributes/builder.rb
+- lib/bronze/entities/attributes/metadata.rb
+- lib/bronze/entities/normalization.rb
+- lib/bronze/entities/primary_key.rb
+- lib/bronze/entities/primary_keys.rb
+- lib/bronze/entities/primary_keys/uuid.rb
+- lib/bronze/entity.rb
+- lib/bronze/not_implemented_error.rb
+- lib/bronze/transform.rb
+- lib/bronze/transforms.rb
+- lib/bronze/transforms/attributes.rb
+- lib/bronze/transforms/attributes/big_decimal_transform.rb
+- lib/bronze/transforms/attributes/date_time_transform.rb
+- lib/bronze/transforms/attributes/date_transform.rb
+- lib/bronze/transforms/attributes/symbol_transform.rb
+- lib/bronze/transforms/attributes/time_transform.rb
+- lib/bronze/transforms/entities.rb
+- lib/bronze/transforms/entities/normalize_transform.rb
+- lib/bronze/transforms/identity_transform.rb
 - lib/bronze/version.rb
 homepage: http://sleepingkingstudios.com
 licenses:
@@ -155,12 +185,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: A composable application framework.