class_composer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1bb350ed5d28637c5d2cf2574450eb66459c14c06a49e6f427eaece430df73f
+  data.tar.gz: db684a27bbe7b948380538952c1a9f6a348c6c2c96c1e7774915b92709b0f372
+SHA512:
+  metadata.gz: 3a316374ba96891a3b1e202893bb79d125db16126636a981b7a19f5aa3caad8b34756f6b650bbc4632996e2de49e8ceb2399b40773213145570d7804fc77a4bd
+  data.tar.gz: 0e04d577ad1984244d0a89be64c407f456d53641486ec06531d7cf390ce8439029dc8cdea7ee42acadb123d8ee1c5e7888e061a1524cee3b2b52c842fa1282d8

data/.circleci/config.yml

@@ -0,0 +1,27 @@
+version: 2.1
+
+orbs:
+  cst: cst/framework@1
+
+workflows:
+  version: 2
+  yeet-le-jobs:
+    jobs:
+      - cst/enforce-gem-version-bump
+      - cst/rspec-ruby:
+          rspec-system-args: "SIMPLE_COV_RUN=true"
+          cc-report-collect-ruby: "2.7.5"
+          matrix:
+            parameters:
+              ruby-version: ["2.7.5" , "3.0.0", "3.0.3"]
+            alias: required-matrix-tests
+          name: test-ruby<< matrix.ruby-version >>
+      - cst/publish-gem:
+          publish-git: true
+          publish-default-gem: true
+          requires:
+            - required-matrix-tests
+          filters:
+            branches:
+              only:
+                - main

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+
+# rspec failure tracking
+.rspec_status
+
+# generated gems
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.1] - 2022-06-18
+
+### Added
+- New feature 1
+- New feature 2
+
+### Changed
+- Changed feature 1
+- Changed feature 2
+
+### Removed
+- Removed feature 1
+- Removed feature 2
+
+### Fixed
+- Bug fix 1
+- Bug fix 2

data/CODEOWNERS

@@ -0,0 +1 @@
+* @matt-taylor

data/Dockerfile

@@ -0,0 +1,16 @@
+FROM ruby:3.0.1
+RUN cd /tmp && curl -L --output ghr.tar.gz https://github.com/tcnksm/ghr/releases/download/v0.12.0/ghr_v0.12.0_linux_amd64.tar.gz && \
+    tar -xzvf ghr.tar.gz && chmod +x ghr_v0.12.0_linux_amd64/ghr && mv ghr_v0.12.0_linux_amd64/ghr /usr/local/bin/ghr && rm -rf /tmp/*
+
+WORKDIR /gem
+COPY Gemfile /gem/Gemfile
+
+COPY class_composer.gemspec /gem/class_composer.gemspec
+COPY lib/class_composer/version.rb /gem/lib/class_composer/version.rb
+
+
+RUN gem update --system && gem install bundler && bundle install --jobs=3 --retry=3 && \
+    rm -rf /usr/local/bundle/cache
+
+COPY . /gem
+RUN gem build class_composer

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in GEMNAME.gemspec
+gemspec
+
+gem 'faker'
+gem 'pry'
+gem 'rspec', '~> 3.0'
+gem 'rspec_junit_formatter'
+gem 'simplecov', require: false, group: :test

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    class_composer (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faker (2.21.0)
+      i18n (>= 1.8.11, < 2)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (12.3.3)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rspec_junit_formatter (0.5.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  class_composer!
+  faker
+  pry
+  pry-byebug
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter
+  simplecov
+
+BUNDLED WITH
+   2.3.16

data/Makefile

@@ -0,0 +1,21 @@
+.PHONY: bash build bundle rspec
+
+APP_NAME?=class-composer
+
+build: #: Build the containers that we'll need
+	docker-compose build --pull
+
+bash: #: Get a bash prompt on the core container
+	docker-compose run --rm -e RAILS_ENV=development $(APP_NAME) bash
+
+bash_test: #: Get a test bash prompt on the core container
+	docker-compose run --rm -e RAILS_ENV=test $(APP_NAME) bash
+
+down: #: Bring down the service -- Destroys everything in redis and all containers
+	docker-compose down
+
+clean: #: Clean up stopped/exited containers
+	docker-compose rm -f
+
+bundle: #: install gems for Dummy App with
+	docker-compose run --rm $(APP_NAME) bundle install

data/README.md

@@ -0,0 +1,50 @@
+# ClassComposer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be
+able to package up your Ruby library into a gem. Put your Ruby code in the file
+`lib/class_composer`. To experiment with that code, run
+`bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'class_composer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install class_composer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake rspec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment. Run `bundle exec class_composer` to use
+the gem in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version:
+
+1. Update the version number in [lib/class_composer/version.rb]
+2. Update [CHANGELOG.md]
+3. Merge to the main branch. This will trigger an automatic build in CircleCI
+   and push the new gem to the repo.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/matt-taylor/class_composer.
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'class_composer'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier.
+
+require 'pry'
+Pry.start

data/bin/publish

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+if [ -z "$GEMFURY_TOKEN" ]; then
+    echo 'Environment variable GEMFURY_TOKEN must be specified. Aborting.'
+    exit 1
+fi
+
+VERSION=$(make version)
+PACKAGE=class_composer-${VERSION}.gem
+
+# Build and publish to Gemfury
+gem build class_composer.gemspec

data/bin/setup

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+lefthook install
+
+# Do any other automated setup that you need to do here

data/class_composer.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/class_composer/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "class_composer"
+  spec.version = ClassComposer::VERSION
+  spec.authors = ["Matt Taylor"]
+  spec.email   = ["mattius.taylor@gmail.com"]
+
+  spec.summary     = "Describe the gem here"
+  spec.description = "Describe the gem here"
+  spec.homepage    = "https://github.com/matt-taylor/class_composer"
+  spec.license     = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7")
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+  }
+
+  # 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
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.17.0"
+end

data/docker-compose.yml

@@ -0,0 +1,15 @@
+version: '3'
+
+services:
+  class-composer:
+    command: tail -f /dev/null
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    volumes:
+      - .:/gem
+      - ..:/local
+      - bundle-cache:/usr/local/bundle:delegated
+
+volumes:
+  bundle-cache:

data/lib/class_composer/array.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ClassComposer
+  class Array
+    def initialize(validator)
+      @validator = validator
+      super
+    end
+
+    def <<
+      value = super
+
+
+
+      value
+    end
+  end
+end

data/lib/class_composer/generator.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "class_composer/version"
+
+module ClassComposer
+  module Generator
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      COMPOSER_VALIDATE_METHOD_NAME = ->(name) { :"__composer_#{name}_is_valid__?" }
+      COMPOSER_ASSIGNED_ATTR_NAME = ->(name) { :"@__composer_#{name}_value_assigned__" }
+      COMPOSER_ASSIGNED_ARRAY_METHODS = ->(name) { :"@__composer_#{name}_array_methods_set__" }
+
+      def add_composer(name, allowed:, default: nil, accessor: true, validator: ->(_) { true }, **params)
+        validate_proc = __composer_validator_proc__(validator: validator, allowed: allowed, name: name)
+        __composer_validate_options__!(name: name, validate_proc: validate_proc, default: default)
+
+        array_proc = __composer_array_proc__(name: name, validator: validator, allowed: allowed, params: params)
+        __composer_assignment__(name: name, params: params, validator: validate_proc, array_proc: array_proc)
+        __composer_retrieval__(name: name, default: default, array_proc: array_proc)
+      end
+
+      def __composer_validate_options__!(name:, validate_proc:, default:)
+        unless validate_proc.(default)
+          raise ClassComposer::ValidatorError, "Default value [#{default}] for #{self.class}.#{name} is not valid"
+        end
+
+        if self.class.instance_methods.include?(name.to_sym)
+          raise ClassComposer::Error, "#{name} is already defined. Ensure composer names are all uniq and do not class with class instance methods"
+        end
+      end
+
+      def __composer_array_proc__(name:, validator:, allowed:, params:)
+        Proc.new do |value, _itself|
+          _itself.send(:"#{name}=", value)
+        end
+      end
+
+      # create assignment method for the incoming name
+      def __composer_assignment__(name:, params:, validator:, array_proc:)
+        define_method(:"#{name}=") do |value|
+          is_valid = validator.(value)
+
+          if is_valid
+            instance_variable_set(COMPOSER_ASSIGNED_ATTR_NAME.(name), true)
+            instance_variable_set(:"@#{name}", value)
+          else
+            value.pop
+            message = ["#{self.class}.#{name} failed validation."]
+
+            message << (params[:invalid_message].is_a?(Proc) ? params[:invalid_message].(value) : params[:invalid_message].to_s)
+            raise ClassComposer::ValidatorError, message.compact.join(" ")
+          end
+
+          if value.is_a?(Array) && !value.instance_variable_get(COMPOSER_ASSIGNED_ARRAY_METHODS.(name))
+            _itself = itself
+            value.define_singleton_method(:<<) do |val|
+              array_proc.(super(val), _itself)
+            end
+            value.instance_variable_set(COMPOSER_ASSIGNED_ARRAY_METHODS.(name), true)
+          end
+
+          value
+        end
+      end
+
+      # retrieve the value for the name -- Or return the default value
+      def __composer_retrieval__(name:, default:, array_proc:)
+        define_method(:"#{name}") do
+          value = instance_variable_get(:"@#{name}")
+          return value if instance_variable_get(COMPOSER_ASSIGNED_ATTR_NAME.(name))
+
+          if default.is_a?(Array) && !default.instance_variable_get(COMPOSER_ASSIGNED_ARRAY_METHODS.(name))
+            _itself = itself
+            default.define_singleton_method(:<<) do |value|
+              array_proc.(super(value), _itself)
+            end
+            default.instance_variable_set(COMPOSER_ASSIGNED_ARRAY_METHODS.(name), true)
+          end
+          default
+        end
+      end
+
+      # create validator method for incoming name
+      def __composer_validator_proc__(validator:, allowed:, name:)
+        if validator && !validator.is_a?(Proc)
+          raise ClassComposer::Error, "Expected validator to be a Proc. Received [#{validator.class}]"
+        end
+
+        # Proc will validate the entire attribute -- Full assignment must occur before validate is called
+        Proc.new do |value|
+          begin
+            allow =
+              if allowed.is_a?(Array)
+                allowed.include?(value.class)
+              else
+                allowed == value.class
+              end
+            allow && validator.(value)
+          rescue StandardError => e
+            raise ClassComposer::Error, "#{e} occured during validation for value [#{value}]. Check custom validator for #{name}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/class_composer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ClassComposer
+  VERSION = "0.0.1"
+end

data/lib/class_composer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "class_composer/version"
+require "class_composer/generator"
+
+module ClassComposer
+  class Error < StandardError; end
+  class ValidatorError < Error; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: class_composer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Taylor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+description: Describe the gem here
+email:
+- mattius.taylor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODEOWNERS
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/publish
+- bin/setup
+- class_composer.gemspec
+- docker-compose.yml
+- lib/class_composer.rb
+- lib/class_composer/array.rb
+- lib/class_composer/generator.rb
+- lib/class_composer/version.rb
+homepage: https://github.com/matt-taylor/class_composer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/matt-taylor/class_composer
+  source_code_uri: https://github.com/matt-taylor/class_composer
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key: 
+specification_version: 4
+summary: Describe the gem here
+test_files: []