trailblazer-declarative 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 243dc1410b80f1a84c5d6a85b7e933d64cb9fee257cf2b5fd63d76c791246e53
+  data.tar.gz: 6186c3c33419a8692bc91dbe3a29fef6b343cee22ccf65a0c429a18e62a48d9d
+SHA512:
+  metadata.gz: 1f0f638638dbd13ef1c7fa8517bba2e6b6d469f5b56df83d93b162ccbcf3efd0d5d6cbb4c8637d535c411a71128a5082ed3da01b80b227c06d15a7ddaab3da1b
+  data.tar.gz: b29bc27efa77142065687093bea0105f0a1c96cc27f576cf8c4ad83a4811348627d780b8a4407be3ecbf0941d59aeb452c51b7cc370e3175ad01f0dd44336ab3

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.11
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.0.1]
+
+- Initial release into an unsuspecting world.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in trailblazer-declarative.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/README.md

@@ -0,0 +1,18 @@
+# Trailblazer::Declarative
+
+
+## State
+
+`State` is a minimalistic state handling object, similar to a hash with
+additional "inheritance" logic via `State#copy`. Every field in `state`
+can have a specific copying strategy, ranging from simply referencing the
+original object to subclassing.
+
+```ruby
+state = Declarative.State(key: ["value", ...])
+state.add!
+state.update!
+state.get
+state.copy # inheritance
+```
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/trailblazer/declarative/schema.rb

@@ -0,0 +1,69 @@
+module Trailblazer
+  module Declarative
+    def self.Schema(&block)
+      Class.new do
+        extend Trailblazer::Declarative::Schema
+        instance_exec(&block)
+      end
+    end
+    # Include this to maintain inheritable, nested schemas with ::defaults and
+    # ::feature the way we have it in Representable, Reform, and Disposable.
+    #
+    # The schema with its defnitions will be kept in ::definitions.
+    #
+    # Requirements to includer: ::default_nested_class, override building with ::nested_builder.
+    module Schema
+      def self.extended(extender)
+        extender.extend DSL                 # ::property
+        # extender.extend Feature             # ::feature
+        # extender.extend Heritage::DSL       # ::heritage
+        # extender.extend Heritage::Inherited # ::included
+
+        extender.initialize_state!() # replaces {@definitions ||= Definitions.new(definition_class)}
+      end
+
+
+      # class << self
+      # end
+
+      module DSL
+        # def initialize_state!()
+        #   @state = State.new
+        # end
+
+        # # @return State
+        # def update_state!(key, value)
+        #   @state = @state.merge(key => value)
+        # end
+
+        def property(name, options={}, &block)
+          # heritage.record(:property, name, options, &block)
+
+          # build_definition(name, options, &block)
+        end
+      end
+
+      module State
+        def initialize_state!(tuples)
+          @state = Declarative.State(tuples)
+        end
+
+        def state
+          @state
+        end
+
+        module Inherited
+          # DISCUSS: this is *not* a class method and will not be executed when extended the first time.
+          def inherited(subclass)
+            super
+
+            inherited_fields = state.copy_fields(subclass: subclass)
+
+            subclass.initialize_state!(inherited_fields) # TODO: discuss, should this be done "in" the subclass rather than here?
+          end
+        end
+      end # Schema::State
+    end # Schema
+
+  end
+end

data/lib/trailblazer/declarative/state.rb

@@ -0,0 +1,65 @@
+module Trailblazer
+  module Declarative
+    # Class-wide configuration data
+    def self.State(tuples={})
+      state = State.new
+      tuples.each { |path, (value, options)| state.add!(path, value, **options) }
+      state
+    end
+
+    class State # FIXME: who is providing the immutable API?
+      def self.dup(value, **) # DISCUSS: should that be here?
+        value.dup
+      end
+
+      def self.subclass(value, **)
+        Class.new(value)
+      end
+
+      def initialize
+        @fields        = {}
+        @field_options = {}
+      end
+
+      def add!(path, value, copy: State.method(:dup))
+        @fields[path]        = value
+        @field_options[path] = {copy: copy}
+        self
+      end
+
+      # Tries to retrieve {path}, if it exists {block} is called
+      # and receives the old value.
+      # The return value of the block will be the new value.
+      def update!(path, &block)
+        value = get(path)
+        new_value = yield(value, **{})
+        set!(path, new_value)
+      end
+
+      def get(path)
+        @fields.fetch(path)
+      end
+
+      # @private
+      def set!(path, value)
+        @fields[path] = value
+      end
+
+      def copy_fields(**options)
+        inherited_fields = @fields.collect do |path, value|
+          path_options = @field_options.fetch(path)
+          inherited_value = path_options.fetch(:copy).(value, **options)
+
+          [path, [inherited_value, path_options]]
+        end.to_h
+      end
+
+      # DISCUSS: do we need it?
+      def copy(**options) # DISCUSS: make class method?
+        inherited_fields = copy_fields(**options)
+
+        Declarative.State(inherited_fields)
+      end
+    end # State
+  end
+end

data/lib/trailblazer/declarative/version.rb

@@ -0,0 +1,5 @@
+module Trailblazer
+  module Declarative
+    VERSION = "0.0.1"
+  end
+end

data/lib/trailblazer/declarative.rb

@@ -0,0 +1,11 @@
+require_relative "declarative/version"
+
+module Trailblazer
+  module Declarative
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end
+
+require_relative "declarative/state"
+require_relative "declarative/schema"

data/trailblazer-declarative.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/trailblazer/declarative/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "trailblazer-declarative"
+  spec.version       = Trailblazer::Declarative::VERSION
+  spec.authors       = ["Nick Sutterer"]
+  spec.email         = ["apotonick@gmail.com"]
+
+  spec.summary       = "Generic DSL providing schemas and inheritance."
+  spec.homepage      = "https://github.com/trailblazer/trailblazer-declarative"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/trailblazer/trailblazer-declarative"
+  spec.metadata["changelog_uri"] = "https://github.com/trailblazer/trailblazer-declarative/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_development_dependency "minitest-line"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: trailblazer-declarative
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nick Sutterer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest-line
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- apotonick@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/trailblazer/declarative.rb
+- lib/trailblazer/declarative/schema.rb
+- lib/trailblazer/declarative/state.rb
+- lib/trailblazer/declarative/version.rb
+- trailblazer-declarative.gemspec
+homepage: https://github.com/trailblazer/trailblazer-declarative
+licenses: []
+metadata:
+  homepage_uri: https://github.com/trailblazer/trailblazer-declarative
+  source_code_uri: https://github.com/trailblazer/trailblazer-declarative
+  changelog_uri: https://github.com/trailblazer/trailblazer-declarative/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Generic DSL providing schemas and inheritance.
+test_files: []