amber_component 0.0.2 → 0.0.3

data/lib/amber_component/template_handler/erb.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'action_view'
+require 'ostruct'
+
+module ::AmberComponent
+  module TemplateHandler
+    # Handles rendering ERB with Rails-like syntax
+    class ERB < ::ActionView::Template::Handlers::ERB::Erubi
+      def initialize(input, properties = {})
+        properties[:bufvar] ||= "@output_buffer"
+        properties[:preamble] = "#{properties[:bufvar]}=#{::ActionView::OutputBuffer}.new;"
+        super
+      end
+    end
+  end
+end

data/lib/amber_component/template_handler.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ::AmberComponent
+  # Provides code which handles rendering different
+  # template languages.
+  module TemplateHandler
+    class << self
+      # @param context [AmberComponent::Base]
+      # @param content [String]
+      # @param type [Symbol, String]
+      # @param block [Proc, nil]
+      # @return [String]
+      def render_from_string(context, content, type, block = nil)
+        options = if type.to_sym == :erb
+                    { engine_class: ERB }
+                  else
+                    {}
+                  end
+
+        ::Tilt[type].new(options) { content }.render(context, &block)
+      end
+    end
+  end
+end
+
+require_relative 'template_handler/erb'

data/lib/amber_component/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ::AmberComponent
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/amber_component/views.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+module ::AmberComponent
+  # Provides methods concerning view registering and rendering.
+  module Views
+    # View types with built-in embedded Ruby
+    #
+    # @return [Set<Symbol>]
+    VIEW_TYPES_WITH_RUBY = ::Set[:erb, :haml, :slim].freeze
+    # @return [Set<Symbol>]
+    ALLOWED_VIEW_TYPES = ::Set[:erb, :haml, :slim, :html, :md, :markdown].freeze
+    # @return [Regexp]
+    VIEW_FILE_REGEXP  = /^view\./.freeze
+
+    # Class methods for views.
+    module ClassMethods
+      # Register an inline view by returning a String from the passed block.
+      #
+      # Usage:
+      #
+      #   view do
+      #     <<~ERB
+      #       <h1>
+      #         Hello <%= @name %>
+      #       </h1>
+      #     ERB
+      #   end
+      #
+      # or:
+      #
+      #   view :haml do
+      #     <<~HAML
+      #       %h1
+      #         Hello
+      #         = @name
+      #     HAML
+      #   end
+      #
+      # @param type [Symbol]
+      # @return [void]
+      def view(type = :erb, &block)
+        @method_view = TypedContent.new(type: type, content: block)
+      end
+
+      # ERB/Haml/Slim view registered through the `view` method.
+      #
+      # @return [TypedContent]
+      attr_reader :method_view
+
+      # @return [String]
+      def view_path
+        asset_path view_file_name
+      end
+
+      # @return [String, nil]
+      def view_file_name
+        files = asset_file_names(VIEW_FILE_REGEXP)
+        raise MultipleViews, "More than one view file for `#{name}` found!" if files.length > 1
+
+        files.first
+      end
+
+      # @return [Symbol]
+      def view_type
+        (view_file_name.split('.')[1..].grep_v(/erb/).last || 'erb')&.to_sym
+      end
+    end
+
+    # Instance methods for views.
+    module InstanceMethods
+      protected
+
+      # @return [String]
+      def render_view(&block)
+        view_from_file   = render_view_from_file(&block)
+        view_from_method = render_class_method_view(&block)
+        view_from_inline = render_view_from_inline(&block)
+
+        view_content = view_from_file unless view_from_file.empty?
+        view_content = view_from_method unless view_from_method.empty?
+        view_content = view_from_inline unless view_from_inline.empty?
+
+        if view_content.nil? || view_content.empty?
+          raise ViewFileNotFound, "View for `#{self.class}` could not be found!"
+        end
+
+        view_content
+      end
+
+      # Helper method to render view from string or with other provided type.
+      #
+      # Usage:
+      #
+      #   render_view_from_content('<h1>Hello World</h1>')
+      #
+      # or:
+      #
+      #   render_view_from_content content: '**Hello World**', type: 'md'
+      #
+      # @param content [TypedContent, Hash{Symbol => String, Symbol, Proc}, String]
+      # @return [String, nil]
+      def render_view_from_content(content, &block)
+        return '' unless content
+        return content if content.is_a?(::String)
+
+        content = TypedContent.wrap(content)
+        type = content.type
+        content = content.to_s
+
+        if content.empty?
+          raise EmptyView, <<~ERR.squish
+            Custom view for `#{self.class}` from view method cannot be empty!
+          ERR
+        end
+
+        unless ALLOWED_VIEW_TYPES.include? type
+          raise UnknownViewType, <<~ERR.squish
+            Unknown view type for `#{self.class}` from view method!
+            Check return value of param type in `view :[type] do`
+          ERR
+        end
+
+        unless VIEW_TYPES_WITH_RUBY.include? type
+          # first render the content with ERB if the
+          # type does not support embedding Ruby by default
+          content = render_string(content, :erb, block)
+        end
+
+        render_string(content, type, block)
+      end
+
+      # @return [String]
+      def render_view_from_file(&block)
+        view_path = self.class.view_path
+        return '' if view_path.nil? || !::File.file?(view_path)
+
+        content = ::File.read(view_path)
+        type = self.class.view_type
+
+        unless VIEW_TYPES_WITH_RUBY.include? type
+          content = render_string(content, :erb, block)
+        end
+
+        render_string(content, type, block)
+      end
+
+      # Method returning view from method in class file.
+      # Usage:
+      #
+      #   view do
+      #     <<~HTML
+      #       <h1>
+      #         Hello <%= @name %>
+      #       </h1>
+      #     HTML
+      #   end
+      #
+      # or:
+      #
+      #   view :haml do
+      #     <<~HAML
+      #       %h1
+      #         Hello
+      #         = @name
+      #     HAML
+      #   end
+      #
+      # @return [String]
+      def render_class_method_view(&block)
+        render_view_from_content(self.class.method_view, &block)
+      end
+
+      # Method returning view from params in view.
+      # Usage:
+      #
+      #   <%= ExampleComponent data: data, view: "<h1>Hello #{@name}</h1>" %>
+      #
+      # or:
+      #
+      #   <%= ExampleComponent data: data, view: { content: "<h1>Hello #{@name}</h1>", type: 'erb' } %>
+      #
+      # @return [String]
+      def render_view_from_inline(&block)
+        data = \
+          if @view.is_a? ::String
+            TypedContent.new(
+              type: :erb,
+              content: @view
+            )
+          else
+            @view
+          end
+
+        render_view_from_content(data, &block)
+      end
+    end
+  end
+end

data/lib/amber_component.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'rails'
 require 'active_support'
 require 'active_support/core_ext'
 
@@ -19,6 +18,11 @@ module ::AmberComponent
 end
 
 require_relative 'amber_component/version'
-require_relative 'amber_component/helper'
+require_relative 'amber_component/helpers'
 require_relative 'amber_component/typed_content'
+require_relative 'amber_component/template_handler'
+require_relative 'amber_component/views'
+require_relative 'amber_component/assets'
+require_relative 'amber_component/rendering'
 require_relative 'amber_component/base'
+require_relative 'amber_component/railtie' if defined?(::Rails::Railtie)

data/lib/generators/amber_component/install_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module ::AmberComponent
+  module Generators
+    # A Rails generator which installs the `amber_component`
+    # library in a Rails project.
+    class InstallGenerator < ::Rails::Generators::Base
+      desc 'Install the AmberComponent gem'
+      source_root ::File.expand_path('templates', __dir__)
+
+      # copy rake tasks
+      def copy_tasks
+        copy_file 'application_component.rb', 'app/components/application_component.rb'
+
+        inject_into_file 'app/assets/stylesheets/application.css', after: "*= require_tree .\n" do
+          " *= require_tree ./../../components\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/amber_component/templates/application_component.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Abstract class which should serve as a superclass
+# for all your custom components in this app.
+#
+# @abstract Subclass to create a new component.
+class ::ApplicationComponent < ::AmberComponent::Base
+  # Include your global application helper.
+  include ::ApplicationHelper
+  # Include the helper methods for your application's
+  # routes.
+  include ::Rails.application.routes.url_helpers
+end

data/lib/generators/amber_component_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+# A Rails generator which creates a new Amber component.
+class AmberComponentGenerator < ::Rails::Generators::NamedBase
+  desc 'Generate a new component'
+  source_root ::File.expand_path('templates', __dir__)
+
+  # copy rake tasks
+  def copy_tasks
+    template 'component.rb.erb', "app/components/#{file_path}.rb"
+    template 'component_test.rb.erb', "test/components/#{file_path}_test.rb"
+    template 'view.html.erb', "app/components/#{file_path}/view.html.erb"
+    template 'style.css.erb', "app/components/#{file_path}/style.css"
+  end
+
+  def file_name
+    name = super
+    return name if name.end_with? '_component'
+
+    "#{name}_component"
+  end
+end

data/lib/generators/templates/component.rb.erb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class <%= class_name %> < ::ApplicationComponent
+  # Your code goes here
+
+  after_initialize do
+    @time = ::Time.now
+  end
+end

data/lib/generators/templates/component_test.rb.erb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class <%= class_name %>Test < ::ActiveSupport::TestCase
+  # test 'the truth' do
+  #   assert true
+  # end
+end

data/lib/generators/templates/style.css.erb

@@ -0,0 +1,3 @@
+.<%= singular_table_name %> {
+  color: blue;
+}

data/lib/generators/templates/view.html.erb

@@ -0,0 +1,3 @@
+<h2 class='<%= singular_table_name %>'>
+  Hello from <b><%= class_name %></b>, initialized at: <%%= @time %>
+</h2>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amber_component
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ruby-Amber
@@ -10,24 +10,38 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2022-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: memery
+  name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -40,6 +54,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6'
+- !ruby/object:Gem::Dependency
+  name: memery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -66,31 +94,69 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".kanbn/index.md"
-- ".kanbn/tasks/add-instance-variables-to-view-when-block-given-markdown.md"
-- ".kanbn/tasks/bind-clas-to-action-view-method-call-example-component-data-data-without-calling-any-method.md"
-- ".kanbn/tasks/bind-scoped-css-to-head-of-doc.md"
-- ".kanbn/tasks/check-if-we-need-full-rails-gem-pack.md"
-- ".kanbn/tasks/simple-proto.md"
-- ".kanbn/tasks/verify-if-template-is-haml-or-erb.md"
 - ".rubocop.yml"
+- ".ruby-gemset"
 - ".ruby-version"
 - ".solargraph.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- PLANS.md
 - README.md
 - Rakefile
 - amber_component.gemspec
+- banner.png
+- docs/.bundle/config
+- docs/.gitignore
+- docs/404.html
+- docs/Gemfile
+- docs/Gemfile.lock
+- docs/README.md
+- docs/_config.yml
+- docs/_data/amber_component.yml
+- docs/_sass/_variables.scss
+- docs/_sass/color_schemes/amber_component.scss
+- docs/_sass/custom/custom.scss
+- docs/api/index.md
+- docs/assets/images/logo_wide.png
+- docs/changelog/index.md
+- docs/favicon.ico
+- docs/getting_started/index.md
+- docs/getting_started/installation.md
+- docs/getting_started/ruby_support.md
+- docs/getting_started/wireframes.md
+- docs/index.md
+- docs/introduction/basic_usage.md
+- docs/introduction/index.md
+- docs/introduction/why_amber_component.md
+- docs/resources/index.md
+- docs/styles/index.md
+- docs/styles/usage.md
+- docs/views/index.md
+- docs/views/usage.md
+- icon.png
 - lib/amber_component.rb
+- lib/amber_component/assets.rb
 - lib/amber_component/base.rb
-- lib/amber_component/helper.rb
-- lib/amber_component/style_injector.rb
+- lib/amber_component/helpers.rb
+- lib/amber_component/helpers/class_helper.rb
+- lib/amber_component/helpers/component_helper.rb
+- lib/amber_component/helpers/css_helper.rb
+- lib/amber_component/railtie.rb
+- lib/amber_component/rendering.rb
+- lib/amber_component/template_handler.rb
+- lib/amber_component/template_handler/erb.rb
 - lib/amber_component/typed_content.rb
 - lib/amber_component/version.rb
-- sig/amber_components.rbs
+- lib/amber_component/views.rb
+- lib/generators/amber_component/install_generator.rb
+- lib/generators/amber_component/templates/application_component.rb
+- lib/generators/amber_component_generator.rb
+- lib/generators/templates/component.rb.erb
+- lib/generators/templates/component_test.rb.erb
+- lib/generators/templates/style.css.erb
+- lib/generators/templates/view.html.erb
 homepage: https://github.com/amber-ruby/amber_component
 licenses:
 - MIT
@@ -106,14 +172,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A simple component library which seamlessly hooks into your Rails project.

data/.kanbn/index.md

@@ -1,23 +0,0 @@
----
-startedColumns:
-  - 'In Progress'
-completedColumns:
-  - Done
----
-
-# Amber Components
-
-## Backlog
-
-- [check-if-we-need-full-rails-gem-pack](tasks/check-if-we-need-full-rails-gem-pack.md)
-- [verify-if-template-is-haml-or-erb](tasks/verify-if-template-is-haml-or-erb.md)
-- [bind-clas-to-action-view-method-call-example-component-data-data-without-calling-any-method](tasks/bind-clas-to-action-view-method-call-example-component-data-data-without-calling-any-method.md)
-- [add-instance-variables-to-view-when-block-given-markdown](tasks/add-instance-variables-to-view-when-block-given-markdown.md)
-
-## In Progress
-
-- [bind-scoped-css-to-head-of-doc](tasks/bind-scoped-css-to-head-of-doc.md)
-
-## Done
-
-- [simple-proto](tasks/simple-proto.md)

data/.kanbn/tasks/add-instance-variables-to-view-when-block-given-markdown.md

@@ -1,9 +0,0 @@
----
-created: 2022-07-24T21:05:00.209Z
-updated: 2022-07-24T21:05:00.205Z
-assigned: ""
-progress: 0
-tags: []
----
-
-# Add instance variables to view when block given - markdown

data/.kanbn/tasks/bind-clas-to-action-view-method-call-example-component-data-data-without-calling-any-method.md

@@ -1,9 +0,0 @@
----
-created: 2022-07-24T09:34:44.925Z
-updated: 2022-07-24T09:35:24.434Z
-assigned: ""
-progress: 0
-tags: []
----
-
-# bind clas to ActionView method (call ExampleComponent data: data - without calling any method)

data/.kanbn/tasks/bind-scoped-css-to-head-of-doc.md

@@ -1,10 +0,0 @@
----
-created: 2022-07-23T15:24:49.521Z
-updated: 2022-07-24T12:09:45.281Z
-assigned: ""
-progress: 0
-tags: []
-started: 2022-07-24T12:09:45.282Z
----
-
-# bind scoped css to head of doc

data/.kanbn/tasks/check-if-we-need-full-rails-gem-pack.md

@@ -1,9 +0,0 @@
----
-created: 2022-07-23T15:23:43.278Z
-updated: 2022-07-23T15:23:43.275Z
-assigned: ""
-progress: 0
-tags: []
----
-
-# check if we need full rails gem pack

data/.kanbn/tasks/simple-proto.md

@@ -1,10 +0,0 @@
----
-created: 2022-07-23T15:23:22.133Z
-updated: 2022-07-24T09:34:38.629Z
-assigned: ""
-progress: 0
-tags: []
-completed: 2022-07-24T09:34:38.629Z
----
-
-# simple proto

data/.kanbn/tasks/verify-if-template-is-haml-or-erb.md

@@ -1,9 +0,0 @@
----
-created: 2022-07-23T15:24:25.486Z
-updated: 2022-07-23T15:24:25.484Z
-assigned: ""
-progress: 0
-tags: []
----
-
-# verify if template is HAML or ERB 

data/PLANS.md

@@ -1,17 +0,0 @@
-app
- |
-  +-- components
-      |
-      +-- example_component.rb
-      |
-      +-- example_component
-          |
-          +-- view.(haml|erb)
-          |
-          +-- style.(scss|css)
-          |
-          +-- script.(coffee|js)
-
-1.0 - actions, scoped styling views, js
-0.5 - components libraries
-0.1 - MVP - actions, views + nesting

data/lib/amber_component/helper.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module ::AmberComponent
-  # Contains methods for quickly rendering
-  # components defined under the root namespace `Object`.
-  module Helper
-  end
-end