component-framework 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 663c497bb487c2f193700b547df7074d6f588200
+  data.tar.gz: 2d757bfa0dc65ffa3f1a7c1ce3f9a724441468b4
+SHA512:
+  metadata.gz: 5454e668f8b6ea498f36e2fcee2521078fa1c7713a6bc63263d04ecf588ca8a0ea4bd83b1dd88b83a6320c36bef67bc3f42f4d8ca55b895e481233df087da18e
+  data.tar.gz: 40f402f768e8efbfc4f8256c306afbfb5626f276051dac23df3667176a3923fab1944afb5b146dec0e9d4dbe3db0e1aafd7db276a4f63415640694b48541f6f7

data/LICENSE.txt

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# Component::Framework
+
+The minimalistic framework for developing Rails component based applications.
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'component-framework'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install component-framework
+
+## Usage
+
+
+Add the following lines to application.rb after your application class declaration.
+
+_application.rb_
+```ruby
+module My
+  class Application < Rails::Application
+    ...
+  end
+
+  Component::Framework.initialize(YourApplication)
+```
+
+### Conventions
+
+
+### Assets
+
+
+### Folder Structure
+
+/components/
+    <name>/
+        assets/
+            images/
+            javascripts/
+            stylesheets/
+        api/
+
+
+### Components Initialization
+
+
+### Routing
+
+
+### DB Migrations
+
+
+### Gemfile
+
+It's recommended to use `group :component_name` for gems required by particular component.
+
+
+### Settings
+
+```ruby  
+settings = Component::Settings.load_settings(:settings)
+config.settings = settings
+```
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/component-framework. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/component/framework/directive_processor.rb

@@ -0,0 +1,31 @@
+
+class Component::Framework::DirectiveProcessor < Sprockets::DirectiveProcessor
+
+  # `require_components` requires all the components manifest files in project.
+  #
+  #  //= require_components assets/javascripts/app.js
+  #  will be resolved to {COMPONENT_BASE_DIR}/{COMPONENT_NAME}/assets/javascripts/app.js
+
+  def process_require_components_directive(manifest_subpath = "assets/javascripts/app.js")
+
+    # gather component manifests with absolute paths.
+    manifests_paths = Component::Framework.get_component_names
+                          .map {|name| Component::Framework.components_base_dir.join(name, manifest_subpath).to_s}
+                          .select { |path| File.exist?(path) }
+                          .sort  # add predictability to require order
+
+    manifests_paths.each { |path| @required << _resolve_absolute(path, accept: @content_type, pipeline: :self) }
+  end
+
+
+  private
+
+
+  def _resolve_absolute(path, options = {})
+    # adapted from Sprockets::DirectiveProcessor.resolve
+    uri, deps = @environment.resolve!(path, options.merge(base_path: @dirname))
+    @dependencies.merge(deps)
+    uri
+  end
+
+end

data/lib/component/framework/railtie.rb

@@ -0,0 +1,16 @@
+
+# Monkeypatch Rails::Application to remove components tests from application's eager load.
+class Rails::Application
+
+  # method adopted from Rails::Engine.eager_load!
+  def eager_load!
+    config.eager_load_paths.each do |load_path|
+      matcher = /\A#{Regexp.escape(load_path.to_s)}\/(.*)\.rb\Z/
+      Dir.glob("#{load_path}/**/*.rb")
+          .reject { |p| p.include?("/test/") }
+          .sort.each do |file|
+        require_dependency file.sub(matcher, '\1')
+      end
+    end
+  end
+end

data/lib/component/framework/sass_importer.rb

@@ -0,0 +1,41 @@
+module Component::Framework
+
+  class ScssTemplate < SassC::Rails::ScssTemplate
+
+    def config_options
+      options = super
+      options[:importer] = Component::Framework::SassImporter
+      return options
+    end
+
+  end
+
+
+  class SassImporter < SassC::Rails::Importer
+
+    def imports(path, parent_path)
+      return _import_components if path == "{all-components}"
+      super
+    end
+
+
+    private
+
+
+    def _import_components
+      context = options[:sprockets][:context]
+      _component_manifest_files.map do |filename|
+        context.depend_on(filename)
+        SassC::Importer::Import.new(filename)
+      end
+    end
+
+
+    def _component_manifest_files
+      Component::Framework.get_component_names
+          .map{ |component| Component::Framework.components_base_dir.join(component, "assets/stylesheets/app.scss").to_s }
+          .select { |path| File.exists?(path) }
+    end
+
+  end
+end

data/lib/component/framework/version.rb

@@ -0,0 +1,5 @@
+module Component
+  module Framework
+    VERSION = "0.1.0"
+  end
+end

data/lib/component/framework.rb

@@ -0,0 +1,172 @@
+require "component/framework/version"
+require "component/settings"
+
+module Component
+  module Framework
+
+    COMPONENT_IMAGE_ASSETS = lambda do |logical_path, filename|
+      filename.start_with?(components_base_dir.to_s) &&
+          %w(.png .jpg .jpeg .gif).include?(File.extname(logical_path))
+    end
+
+
+    def self.components_base_dir
+      @base_dir ||= Rails.root.join("components")
+    end
+
+
+    def self.initialize(application, assets_pipeline: true)
+
+      # patch Rails
+      require "component/framework/railtie"
+
+      log("Components Initialization Started")
+      log("Components Path: #{components_base_dir}")
+
+      # add eager and autoload path that will allow to eager load and resolve components with namespaces.
+      application.config.paths.add components_base_dir.to_s, eager_load: true
+
+      log("Discovered Components: #{get_component_names.join(", ")}")
+
+      log("Register DB Migrations")
+      _get_component_migrations_paths.each { |path| application.config.paths["db/migrate"].push(path) }
+
+      log("Register Components Routes")
+      application.config.paths["config/routes.rb"].unshift(*_get_component_routing_paths)
+
+      log("Register Components Helpers")
+      application.config.paths["app/helpers"].unshift(*_get_component_helpers_paths)
+
+      if assets_pipeline
+        _initialize_assets_pipeline(application)
+      end
+
+      # Initialize components after all initialization finished.
+      application.config.after_initialize do |app|
+
+        log("Load Components Initializers")
+        _load_components_initializers
+
+        components = get_component_modules
+        log("Initialize Components")
+        components.each {|component| component.send("init") if component.respond_to?("init") }
+
+        log("Post-Initialize Components")
+        components.each {|component| component.send("ready") if component.respond_to?("ready") }
+
+        log("Components Initialization Done")
+      end
+
+      log("Configuration Finished")
+    end
+
+
+    def self.get_component_names
+      Dir.entries(components_base_dir)
+          .select { |entry| (entry !="." && entry != "..") and File.directory? components_base_dir.join(entry) }
+    end
+
+
+    def self.get_component_modules
+      get_component_names.map { |name| component_module_by_name(name) }
+    end
+
+
+    def self.component_module_by_name(name)
+      return name.camelize.constantize
+    rescue NameError, ArgumentError
+      message = "Component #{name} not found"
+      log(message)
+      raise ComponentNotFoundError, message
+    end
+
+
+    private
+
+
+    def self._initialize_assets_pipeline(application)
+
+      log("Register Components Assets")
+      application.config.assets.paths += _get_component_assets_paths
+      application.config.assets.precompile += [COMPONENT_IMAGE_ASSETS]
+
+
+      # We need to override SassC configuration
+      # so we need to register after SassC app.config.assets.configure
+      application.initializer :setup_component_sass, group: :all, after: :setup_sass do |app|
+
+        require "component/framework/directive_processor"
+        require "component/framework/sass_importer"
+
+        app.config.assets.configure do |sprockets_env|
+          Component::Framework.log("Register assets directive processors")
+          sprockets_env.unregister_preprocessor "application/javascript", Sprockets::DirectiveProcessor
+          sprockets_env.unregister_preprocessor "text/css", Sprockets::DirectiveProcessor
+
+          sprockets_env.register_preprocessor "application/javascript", Component::Framework::DirectiveProcessor
+          sprockets_env.register_preprocessor "text/css", Component::Framework::DirectiveProcessor
+
+          Component::Framework.log("Add .scss `@import all-components` support")
+          sprockets_env.register_transformer "text/scss", "text/css", Component::Framework::ScssTemplate.new
+          sprockets_env.register_engine(".scss", Component::Framework::ScssTemplate, { silence_deprecation: true })
+        end
+      end
+    end
+
+
+    def self._get_component_migrations_paths
+      _existing_component_subpaths("migrations")
+    end
+
+
+    def self._get_component_helpers_paths
+      _existing_component_subpaths("api/helpers")
+    end
+
+
+    def self._get_component_assets_paths
+      styles = _existing_component_subpaths("assets/stylesheets")
+      scripts = _existing_component_subpaths("assets/javascripts")
+      images = _existing_component_subpaths("assets/images")
+      return styles + scripts + images
+    end
+
+
+    def self._get_component_routing_paths
+      # All routes.rb files under /components folder
+      Dir.glob(components_base_dir.join("**/routes.rb"))
+    end
+
+
+    def self._load_components_initializers
+      # initializers are optional, so ignore the missing ones
+      get_component_names.each do |name|
+        begin
+          require_relative(components_base_dir.join("#{name}/initialize"))
+        rescue LoadError
+        end
+      end
+    end
+
+
+    def self._existing_component_subpaths(subpath)
+      get_component_names.map { |component| components_base_dir.join(component, subpath).to_s }
+          .select { |path| File.exists?(path) }
+    end
+
+
+    def self.log(message)
+      message = "[CF init] " + message
+      if Rails.logger
+        Rails.logger.info(message)
+      else
+        puts message
+      end
+    end
+
+  end
+
+
+  class ComponentNotFoundError < StandardError; end
+
+end

data/lib/component/settings.rb

@@ -0,0 +1,54 @@
+
+INCLUDE_KEY = "__include__"
+
+
+module Component
+
+  module Settings
+
+    # Loads settings YAML and returns hash with settings names/values
+    #
+    # In case {name}.override.yml file present, its content merged on top of settings file.
+    #
+    # Adapted from Rails.application.config_for()
+    # YAML format key:env:value
+    #
+    # @param name [String] settings file name.
+    # @param env [String] environment name, by default Rails.env will be used.
+    def self.load_settings(name, env: nil)
+      env ||= Rails.env
+      settings = _load_settings_file(name, env)
+      if settings.nil?
+        raise "Could not load configuration. No such file - #{name}.yml"
+      end
+
+      overrides = _load_settings_file(name.to_s + ".override", env)
+      if overrides.present?
+        settings.deep_merge!(overrides)
+      end
+
+      settings.with_indifferent_access.freeze
+    end
+
+
+    def self._load_settings_file(name, env)
+      yaml_file = Pathname.new("#{Rails.application.paths["config"].existent.first}/#{name}.yml")
+
+      if yaml_file.exist?
+        require "erb"
+        yaml = (YAML.load(ERB.new(yaml_file.read).result) || {})
+
+        result = yaml.map { |k, v| [k, v[env] || {}] }.to_h
+
+        return result
+      else
+        return nil
+      end
+    rescue Psych::SyntaxError => e
+      raise "YAML syntax error occurred while parsing #{yaml_file}. " \
+            "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
+            "Error: #{e.message}"
+    end
+
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: component-framework
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Yegorov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- ayroff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/component/framework.rb
+- lib/component/framework/directive_processor.rb
+- lib/component/framework/railtie.rb
+- lib/component/framework/sass_importer.rb
+- lib/component/framework/version.rb
+- lib/component/settings.rb
+homepage: https://github.com/brokermint/component-framework
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: The minimalistic framework for developing component based applications.
+test_files: []