ree 1.0.0

data/lib/ree/templates/template_detector.rb

@@ -0,0 +1,35 @@
+class Ree::TemplateDetector
+  DEFAULT_TEMPLATES_DIRECTORY = File.expand_path(__dir__)
+
+  def initialize(project_path)
+    @all_templates_directory ||= File.join(project_path, ".ree", "templates")
+  end
+
+  def detect_template_folder(template_name)
+    template_path = [@all_templates_directory, DEFAULT_TEMPLATES_DIRECTORY]
+      .map    {|dir| File.join(dir, template_name.to_s)}
+      .detect  {|dir| Dir.exist?(dir)}
+
+    raise Ree::Error.new('Template does not exist') if template_path.nil?
+
+    template_path
+  end
+
+  def gem_template_folder(template_name)
+    File.join(DEFAULT_TEMPLATES_DIRECTORY, template_name.to_s)
+  end
+
+  def project_template_folder(template_name)
+    File.join(@all_templates_directory, template_name.to_s)
+  end
+
+  def template_file_path(template_name, relative_path)
+    file_path = [detect_template_folder(template_name), DEFAULT_TEMPLATES_DIRECTORY]
+      .map {|folder| File.join(folder, relative_path)}
+      .detect {|file| File.exists?(file)}
+
+      raise Ree::Error.new('Template does not exist') if file_path.nil?
+
+    file_path
+  end
+end

data/lib/ree/templates/template_renderer.rb

@@ -0,0 +1,55 @@
+class Ree::TemplateRenderer
+  TEMPLATE_VARIABLE = /<%=\s*([\w\d-]+)\s*%>/i
+
+  class << self
+    def handle(template, locals = {})
+      Ree::TemplateRenderer.new(template, locals).handle
+    end
+
+    def get_undefined_variables(template, locals = {})
+      Ree::TemplateRenderer.new(template, locals).get_undefined_variables
+    end
+  end
+
+  def initialize(template, locals)
+    @template = template
+    @locals   = locals
+    @undefined_variables = []
+  end
+
+  def handle
+    raise Ree::Error.new("Template variable not defined: #{get_undefined_variables.map(&:to_s).join(';')}") if get_undefined_variables.any?
+
+    Ree::RenderUtils.render(@template, @locals)
+  end
+
+  def get_undefined_variables
+    Ree::RenderUtils.render(@template, @locals)
+
+    @undefined_variables
+  rescue NameError => e
+    raise NoMethodError, "Undefined method for template. Please, add :#{e.name} method to .ree/helpers/render_helper.rb file!" if @undefined_variables.include?(e.name)
+
+    @locals[e.name] = e.name.to_s
+    @undefined_variables.push(e.name)
+
+    retry
+  end
+
+  private
+
+  def get_template_variables
+    Ree::RenderUtils.render(@template, {})
+  rescue NameError => e
+    @locals
+
+    get_template_variables(@template, fake_locals, undefined_variables)
+  end
+
+  def get_passed_variables
+    @locals
+      .keys
+      .uniq
+      .map(&:intern)
+  end
+end

data/lib/ree/utils/render_utils.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal  = true
+
+require 'erb'
+
+class Ree::RenderUtils
+  def self.render(template, locals)
+    new(locals).render(template)
+  end
+
+  def initialize(locals = {})
+    @render_binding = binding
+    @locals         = locals
+  end
+
+  def render(template)
+    @locals.each { |variable, value| @render_binding.local_variable_set(variable, value) }
+
+    ERB.new(template).result(@render_binding)
+  end
+end

data/lib/ree/utils/string_utils.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal  = true
+
+class Ree::StringUtils
+  class << self
+    def truncate(str, limit = 80)
+      str.length > limit ? "#{str[0..limit]}..." : str
+    end
+    
+    def underscore(camel_cased_word)
+      return camel_cased_word unless /[A-Z-]|::/.match?(camel_cased_word)
+      word = camel_cased_word.to_s.gsub("::".freeze, "/".freeze)
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2'.freeze)
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2'.freeze)
+      word.tr!("-".freeze, "_".freeze)
+      word.downcase!
+      word
+    end
+
+    def camelize(string, uppercase_first_letter = true)
+      if uppercase_first_letter
+        string = string.sub(/^[a-z\d]*/) { |match| match.capitalize }
+      else
+        string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { |match| match.downcase }
+      end
+      
+      string.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub("/", "::")
+    end
+  end
+end

data/lib/ree/version.rb

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

data/lib/ree.rb

@@ -0,0 +1,279 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'pathname'
+require_relative 'ree/version'
+require 'fileutils'
+
+module Ree
+  autoload :Args, 'ree/args'
+  autoload :BeanDSL, 'ree/bean_dsl'
+  autoload :CLI, 'ree/cli'
+  autoload :Container, 'ree/container'
+  autoload :Contracts, 'ree/contracts'
+  autoload :DomainError, 'ree/dsl/domain_error'
+  autoload :Error, 'ree/error'
+  autoload :ErrorBuilder, 'ree/dsl/error_builder'
+  autoload :ErrorDsl, 'ree/dsl/error_dsl'
+  autoload :FnDSL, 'ree/fn_dsl'
+  autoload :Gen, 'ree/gen'
+  autoload :ImportDsl, 'ree/dsl/import_dsl'
+  autoload :LinkDSL, 'ree/link_dsl'
+  autoload :LinkImportBuilder, 'ree/dsl/link_import_builder'
+  autoload :LinkValidator, 'ree/core/link_validator'
+  autoload :Object, 'ree/core/object'
+  autoload :ObjectCompiler, 'ree/object_compiler'
+  autoload :ObjectDsl, 'ree/dsl/object_dsl'
+  autoload :ObjectError, 'ree/core/object_error'
+  autoload :ObjectLink, 'ree/core/object_link'
+  autoload :ObjectSchema, 'ree/core/object_schema'
+  autoload :ObjectSchemaBuilder, 'ree/core/object_schema_builder'
+  autoload :Package, 'ree/core/package'
+  autoload :PackageDep, 'ree/core/package_dep'
+  autoload :BuildPackageDsl, 'ree/dsl/build_package_dsl'
+  autoload :PackageDSL, 'ree/package_dsl'
+  autoload :PackageEnvVar, 'ree/core/package_env_var'
+  autoload :PackageLoader, 'ree/core/package_loader'
+  autoload :PackageSchema, 'ree/core/package_schema'
+  autoload :PackageSchemaBuilder, 'ree/core/package_schema_builder'
+  autoload :PackageSchemaLoader, 'ree/core/package_schema_loader'
+  autoload :PackagesDetector, 'ree/core/packages_detector'
+  autoload :PackagesFacade, 'ree/facades/packages_facade'
+  autoload :PackagesSchema, 'ree/core/packages_schema'
+  autoload :PackagesSchemaBuilder, 'ree/core/packages_schema_builder'
+  autoload :PackagesSchemaLoader, 'ree/core/packages_schema_loader'
+  autoload :PackagesSchemaLocator, 'ree/core/packages_schema_locator'
+  autoload :PackagesStore, 'ree/core/packages_store'
+  autoload :PathHelper, 'ree/core/path_helper'
+  autoload :RenderUtils, 'ree/utils/render_utils'
+  autoload :RSpecLinkDSL, 'ree/rspec_link_dsl'
+  autoload :SpecRunner, 'ree/spec_runner'
+  autoload :StringUtils, 'ree/utils/string_utils'
+  autoload :TemplateDetector, 'ree/templates/template_detector'
+  autoload :TemplateHandler, 'ree/handlers/template_handler'
+  autoload :TemplateRenderer, 'ree/templates/template_renderer'
+
+  PACKAGE = 'package'
+  SCHEMAS = 'schemas'
+  SCHEMA = 'schema'
+  REE_SETUP = 'ree.setup.rb'
+  PACKAGE_SCHEMA_FILE = 'Package.schema.json'
+  PACKAGES_SCHEMA_FILE = 'Packages.schema.json'
+  ROOT_DIR_MESSAGE = 'Ree.root_dir is not set. Use Ree.init(DIR) to set project dir'
+
+  class ReeGem
+    include Ree::Args
+
+    attr_reader :name, :dir, :packages_schema_path
+
+    def initialize(name, dir, packages_schema_path)
+      check_arg(name, :name, Symbol)
+      check_arg(dir, :dir, String)
+      @name = name
+      @dir = dir
+      @packages_schema_path = packages_schema_path
+    end
+  end
+
+  class << self
+    include Ree::Args
+
+    def container
+      Container.instance
+    end
+
+    def logger
+      @logger ||= begin
+        logger = Logger.new(STDOUT)
+        logger.level = Logger::WARN
+        logger
+      end
+
+      @logger
+    end
+
+    # Switches Ree into irb mode that allows to declare ree objects inside IRB
+    def enable_irb_mode
+      @irb_mode = true
+    end
+
+    def disable_irb_mode
+      @irb_mode = false
+    end
+
+    def disable_contracts
+      ENV['NO_CONTRACTS'] = 'true'
+    end
+
+    def enable_contracts
+      ENV['NO_CONTRACTS'] = nil
+    end
+
+    def irb_mode?
+      !!@irb_mode
+    end
+
+    def set_logger_debug
+      logger.level = Logger::DEBUG
+    end
+
+    # Ree will use schema files to load packages and registered objects
+    def set_performance_mode
+      @performance_mode = true
+    end
+
+    def set_dev_mode
+      @performance_mode = false
+    end
+
+    def performance_mode?
+      !!@performance_mode
+    end
+
+    # Define preload context for registered objects
+    def preload_for(env)
+      check_arg(env, :env, Symbol)
+      @prelaod_for = env
+    end
+
+    def preload_for?(env)
+      check_arg(env, :env, Symbol)
+      @prelaod_for == env
+    end
+
+    def init(dir, irb: false)
+      check_arg(dir, :dir, String)
+
+      if !Dir.exists?(dir)
+        raise Ree::Error.new("Dir does not exist: #{dir}", :invalid_root_dir)
+      end
+
+      @packages_schema_path = locate_packages_schema(dir)
+      @root_dir = Pathname.new(@packages_schema_path).dirname.to_s
+
+      ree_setup_path = File.join(@root_dir, REE_SETUP)
+
+      if File.exists?(ree_setup_path)
+        require(ree_setup_path)
+      end
+
+      if irb
+        require('irb')
+        enable_irb_mode
+
+        FileUtils.cd(@root_dir) do
+          IRB.start(@root_dir)
+        end
+      end
+
+      @root_dir
+    end
+
+    # @param [Symbol] name
+    # @return [Nilor[Ree::ReeGem]]
+    def gem(name)
+      check_arg(name, :name, Symbol)
+      gems.detect { _1.name == name }
+    end
+
+    def gems
+      @gems ||= []
+      @gems
+    end
+
+    # @param [Symbol] name
+    # @param [String] dir
+    # @return [Ree::ReeGem]]
+    def register_gem(gem_name, dir)
+      check_arg(gem_name, :gem_name, Symbol)
+      check_arg(dir, :dir, String)
+
+      if gem(gem_name)
+        raise Ree::Error.new("Ree already registered gem `#{name}`", :duplicate_gem)
+      end
+
+      if !Dir.exists?(dir)
+        raise Ree::Error.new("Dir does not exist: #{dir}", :invalid_gem_dir)
+      end
+
+      dir = File.expand_path(dir)
+      packages_schema_path = locate_packages_schema(dir)
+      gem_dir = Pathname.new(packages_schema_path).dirname.to_s
+      ree_setup_path = File.join(gem_dir, REE_SETUP)
+
+      if File.exists?(ree_setup_path)
+        require(ree_setup_path)
+      end
+
+      gem = ReeGem.new(gem_name, gem_dir, packages_schema_path)
+      @gems.push(gem)
+
+      gem
+    end
+
+    def load_package(name)
+      check_arg(name, :name, Symbol)
+      container.load_package(name)
+    end
+
+    def locate_packages_schema(path)
+      check_arg(path, :path, String)
+      Ree.logger.debug("locate_packages_schema: #{path}")
+      Ree::PackagesSchemaLocator.new.call(path)
+    end
+
+    def packages_schema_path
+      @packages_schema_path || (raise Ree::Error.new(ROOT_DIR_MESSAGE, :invalid_root_dir))
+    end
+
+    def root_dir
+      @root_dir || (raise Ree::Error.new(ROOT_DIR_MESSAGE, :invalid_root_dir))
+    end
+
+    def write_object_schema(package_name, object_name)
+      check_arg(package_name, :package_name, Symbol)
+      check_arg(object_name, :object_name, Symbol)
+      container.packages_facade.write_object_schema(package_name, object_name)
+    end
+
+    def generate_schemas_for_all_packages(silence = false)
+      Ree.logger.debug("generate_schemas_for_all_packages") if !silence
+      facade = container.packages_facade
+
+      facade.class.write_packages_schema
+      facade.load_packages_schema
+
+      facade.packages_store.packages.each do |package|
+        puts("Generating Package.schema.json for :#{package.name} package") if !silence
+
+        facade.load_entire_package(package.name)
+        facade.write_package_schema(package.name)
+
+        schemas_path = Ree::PathHelper.abs_package_object_schemas_path(package)
+
+        FileUtils.rm_rf(schemas_path)
+        FileUtils.mkdir_p(schemas_path)
+
+        package.objects.each do |object|
+          next if !object.schema_rpath
+          write_object_schema(package.name, object.name)
+        end
+      end
+    end
+
+    def error_types
+      @error_types ||= []
+    end
+
+    def add_error_types(*args)
+      args.each do |arg|
+        check_arg(arg, :error, Symbol)
+      end
+
+      @error_types = (error_types + args).uniq
+    end
+  end
+end
+
+require_relative 'ree/dsl/object_hooks'
+require_relative 'ree/dsl/package_require'

data/sig/ree.rbs

@@ -0,0 +1,4 @@
+module Ree
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: ree
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ruslan Gatiyatov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+description: Ree makes your ruby life happier
+email:
+- ruslan.gatiyatov@gmail.com
+executables:
+- ree
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/ree
+- lib/ree.rb
+- lib/ree/args.rb
+- lib/ree/bean_dsl.rb
+- lib/ree/cli.rb
+- lib/ree/cli/generate_package.rb
+- lib/ree/cli/generate_package_schema.rb
+- lib/ree/cli/generate_packages_schema.rb
+- lib/ree/cli/generate_template.rb
+- lib/ree/cli/init.rb
+- lib/ree/cli/spec_runner.rb
+- lib/ree/container.rb
+- lib/ree/contracts.rb
+- lib/ree/contracts/arg_contracts.rb
+- lib/ree/contracts/arg_contracts/any.rb
+- lib/ree/contracts/arg_contracts/array_of.rb
+- lib/ree/contracts/arg_contracts/block.rb
+- lib/ree/contracts/arg_contracts/bool.rb
+- lib/ree/contracts/arg_contracts/eq.rb
+- lib/ree/contracts/arg_contracts/exactly.rb
+- lib/ree/contracts/arg_contracts/hash_of.rb
+- lib/ree/contracts/arg_contracts/ksplat.rb
+- lib/ree/contracts/arg_contracts/kwargs.rb
+- lib/ree/contracts/arg_contracts/nilor.rb
+- lib/ree/contracts/arg_contracts/none.rb
+- lib/ree/contracts/arg_contracts/optblock.rb
+- lib/ree/contracts/arg_contracts/or.rb
+- lib/ree/contracts/arg_contracts/range_of.rb
+- lib/ree/contracts/arg_contracts/set_of.rb
+- lib/ree/contracts/arg_contracts/splat.rb
+- lib/ree/contracts/arg_contracts/splat_of.rb
+- lib/ree/contracts/arg_contracts/squarable.rb
+- lib/ree/contracts/arg_contracts/subclass_of.rb
+- lib/ree/contracts/called_args_validator.rb
+- lib/ree/contracts/contract_definition.rb
+- lib/ree/contracts/contractable.rb
+- lib/ree/contracts/core.rb
+- lib/ree/contracts/engine.rb
+- lib/ree/contracts/engine_proxy.rb
+- lib/ree/contracts/errors/bad_contract_error.rb
+- lib/ree/contracts/errors/contract_error.rb
+- lib/ree/contracts/errors/error.rb
+- lib/ree/contracts/errors/return_contract_error.rb
+- lib/ree/contracts/method_decorator.rb
+- lib/ree/contracts/truncatable.rb
+- lib/ree/contracts/utils.rb
+- lib/ree/contracts/validators.rb
+- lib/ree/contracts/validators/array_validator.rb
+- lib/ree/contracts/validators/base_validator.rb
+- lib/ree/contracts/validators/class_validator.rb
+- lib/ree/contracts/validators/default_validator.rb
+- lib/ree/contracts/validators/hash_validator.rb
+- lib/ree/contracts/validators/proc_validator.rb
+- lib/ree/contracts/validators/range_validator.rb
+- lib/ree/contracts/validators/regexp_validator.rb
+- lib/ree/contracts/validators/valid_validator.rb
+- lib/ree/core/link_validator.rb
+- lib/ree/core/object.rb
+- lib/ree/core/object_error.rb
+- lib/ree/core/object_link.rb
+- lib/ree/core/object_schema.rb
+- lib/ree/core/object_schema_builder.rb
+- lib/ree/core/package.rb
+- lib/ree/core/package_dep.rb
+- lib/ree/core/package_env_var.rb
+- lib/ree/core/package_loader.rb
+- lib/ree/core/package_schema.rb
+- lib/ree/core/package_schema_builder.rb
+- lib/ree/core/package_schema_loader.rb
+- lib/ree/core/packages_detector.rb
+- lib/ree/core/packages_schema.rb
+- lib/ree/core/packages_schema_builder.rb
+- lib/ree/core/packages_schema_loader.rb
+- lib/ree/core/packages_schema_locator.rb
+- lib/ree/core/packages_store.rb
+- lib/ree/core/path_helper.rb
+- lib/ree/dsl/build_package_dsl.rb
+- lib/ree/dsl/domain_error.rb
+- lib/ree/dsl/error_builder.rb
+- lib/ree/dsl/error_dsl.rb
+- lib/ree/dsl/import_dsl.rb
+- lib/ree/dsl/link_import_builder.rb
+- lib/ree/dsl/object_dsl.rb
+- lib/ree/dsl/object_hooks.rb
+- lib/ree/dsl/package_require.rb
+- lib/ree/error.rb
+- lib/ree/facades/packages_facade.rb
+- lib/ree/fn_dsl.rb
+- lib/ree/gen.rb
+- lib/ree/gen/init.rb
+- lib/ree/gen/package.rb
+- lib/ree/handlers/template_handler.rb
+- lib/ree/link_dsl.rb
+- lib/ree/object_compiler.rb
+- lib/ree/package_dsl.rb
+- lib/ree/rspec_link_dsl.rb
+- lib/ree/spec_runner.rb
+- lib/ree/spec_runner/command_generator.rb
+- lib/ree/spec_runner/command_params.rb
+- lib/ree/spec_runner/runner.rb
+- lib/ree/spec_runner/spec_filename_matcher.rb
+- lib/ree/spec_runner/view.rb
+- lib/ree/templates/init/.gitignore
+- lib/ree/templates/init/.irbrc
+- lib/ree/templates/init/.rspec
+- lib/ree/templates/init/.ruby-version
+- lib/ree/templates/init/Gemfile
+- lib/ree/templates/init/Packages.schema.json
+- lib/ree/templates/init/bin/console
+- lib/ree/templates/init/readme.md
+- lib/ree/templates/init/ree.setup.rb
+- lib/ree/templates/init/spec.init.rb
+- lib/ree/templates/package/.gitignore
+- lib/ree/templates/package/.rspec
+- lib/ree/templates/package/<%=package_subdir_name%>/<%=package_name%>.rb
+- lib/ree/templates/package/<%=package_subdir_name%>/<%=package_name%>/.gitkeep
+- lib/ree/templates/package/Package.schema.json
+- lib/ree/templates/package/bin/console
+- lib/ree/templates/package/spec/package_schema_spec.rb
+- lib/ree/templates/package/spec/spec_helper.rb
+- lib/ree/templates/template_detector.rb
+- lib/ree/templates/template_renderer.rb
+- lib/ree/utils/render_utils.rb
+- lib/ree/utils/string_utils.rb
+- lib/ree/version.rb
+- sig/ree.rbs
+homepage: https://github.com/glabix/ree/ree
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/glabix/ree/ree
+  source_code_uri: https://github.com/glabix/ree/ree
+  changelog_uri: https://github.com/glabix/ree/ree/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Ruby framework to create modular applications
+test_files: []