amber_component 0.0.3 → 0.0.5

data/lib/amber_component/props.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require_relative 'prop_definition'
+
+module ::AmberComponent
+  # Provides a DSL for defining component
+  # properties.
+  module Props
+    # Class methods for component properties.
+    module ClassMethods
+      # @return [Hash{Symbol => AmberComponent::Prop}]
+      attr_reader :prop_definitions
+
+      # @param names [Array<Symbol>]
+      # @param type [Class, nil]
+      # @param required [Boolean]
+      # @param default [Object, Proc, nil]
+      # @param allow_nil [Boolean]
+      def prop(*names, type: nil, required: false, default: nil, allow_nil: false)
+        @prop_definitions ||= {}
+        include(@prop_methods_module = ::Module.new) if @prop_methods_module.nil?
+
+        names.each do |name|
+          @prop_definitions[name] = prop_def = PropDefinition.new(
+            name: name,
+            type: type,
+            required: required,
+            default: default,
+            allow_nil: allow_nil
+          )
+          raise IncorrectPropTypeError, <<~MSG unless type.nil? || type.is_a?(::Class)
+            `type` should be a class but received `#{type.inspect}` (`#{type.class}`)
+          MSG
+
+          @prop_methods_module.attr_reader name
+          next @prop_methods_module.attr_writer(name) unless prop_def.type?
+
+          @prop_methods_module.class_eval( # rubocop:disable Style/DocumentDynamicEvalDefinition
+            # def phone=(val)
+            #   raise IncorrectPropTypeError, <<~MSG unless val.nil? || val.is_a?(String)
+            #     #{self.class} received `#{val.class}` instead of `String` for `phone` prop
+            #   MSG
+            #
+            #   @phone = val
+            # end
+            <<~RUB, __FILE__, __LINE__ + 1
+              def #{name}=(val)
+                raise IncorrectPropTypeError, <<~MSG unless #{allow_nil ? 'val.nil? ||' : nil} val.is_a?(#{prop_def.type})
+                  \#{self.class} received `\#{val.class}` instead of `#{prop_def.type}` for `#{name}` prop
+                MSG
+
+                @#{name} = val
+              end
+            RUB
+          ) # rubocop:disable Layout/HeredocArgumentClosingParenthesis
+        end
+      end
+
+      # @return [Array<Symbol>, nil]
+      def prop_names
+        @prop_definitions.keys
+      end
+
+      # @return [Array<Symbol>, nil]
+      def required_prop_names
+        @prop_definitions&.filter_map do |name, prop_def|
+          next unless prop_def.required
+
+          name
+        end
+      end
+    end
+
+    # Instance methods for component properties.
+    module InstanceMethods
+      private
+
+      # @param props [Hash{Symbol => Object}]
+      def initialize(**kwargs)
+        bind_props(kwargs)
+      end
+
+      # @param props [Hash{Symbol => Object}]
+      # @return [Boolean] `false` when there are no props defined on the class
+      #   and `true` otherwise
+      # @raise [AmberComponent::MissingPropsError] when required props are missing
+      # @raise [AmberComponent::IncorrectPropTypeError]
+      def bind_props(props)
+        return false if self.class.prop_definitions.nil?
+
+        self.class.prop_definitions.each do |name, prop_def|
+          setter_name = :"#{name}="
+          public_send(setter_name, prop_def.default!) if prop_def.default?
+
+          prop_present = props.include? name
+
+          raise MissingPropsError, <<~MSG if prop_def.required? && !prop_present
+            `#{self.class}` has a missing required prop: `#{name.inspect}`
+          MSG
+
+          next unless prop_present
+
+          value = props[name]
+          public_send(setter_name, value)
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/amber_component/test_helper.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module AmberComponent
+  # Provides assertions for the rendered
+  # HTML of components.
+  module TestHelper
+    begin
+      require 'capybara/minitest'
+      include ::Capybara::Minitest::Assertions
+
+      def page
+        @page ||= ::Capybara::Node::Simple.new(@rendered_content)
+      end
+    rescue ::LoadError
+      nil
+    end
+
+    # @return [Nokogiri::HTML]
+    def document
+      ::Nokogiri::HTML.fragment(@rendered_content)
+    end
+    alias doc document
+    alias html document
+
+    # @param content [String]
+    # @return [Nokogiri::HTML]
+    def render(content = nil)
+      @page = nil
+      @rendered_content = content || yield
+      document
+    end
+    alias render_inline render
+  end
+end

data/lib/amber_component/typed_content.rb

@@ -9,9 +9,9 @@ module ::AmberComponent
       def wrap(val)
         return val if val.is_a?(self)
 
-        unless val.respond_to?(:[])
-          raise InvalidType, "`TypedContent` should be a `Hash` or `#{self}` but was `#{val.class}` (#{val.inspect})"
-        end
+        raise InvalidTypeError, <<~MSG unless val.respond_to?(:[])
+          `TypedContent` should be a `Hash` or `#{self}` but was `#{val.class}` (#{val.inspect})
+        MSG
 
         new(type: val[:type], content: val[:content])
       end

data/lib/amber_component/version.rb

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

data/lib/amber_component/views.rb

@@ -55,7 +55,7 @@ module ::AmberComponent
       # @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
+        raise MultipleViewsError, "More than one view file for `#{name}` found!" if files.length > 1
 
         files.first
       end
@@ -81,7 +81,7 @@ module ::AmberComponent
         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!"
+          raise ViewFileNotFoundError, "View for `#{self.class}` could not be found!"
         end
 
         view_content
@@ -108,13 +108,13 @@ module ::AmberComponent
         content = content.to_s
 
         if content.empty?
-          raise EmptyView, <<~ERR.squish
+          raise EmptyViewError, <<~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
+          raise UnknownViewTypeError, <<~ERR.squish
             Unknown view type for `#{self.class}` from view method!
             Check return value of param type in `view :[type] do`
           ERR

data/lib/amber_component.rb

@@ -5,16 +5,14 @@ require 'active_support/core_ext'
 
 module ::AmberComponent
   class Error < ::StandardError; end
-  class ViewFileNotFound < Error; end
-  class InvalidType < Error; end
+  class MissingPropsError < Error; end
+  class IncorrectPropTypeError < Error; end
+  class ViewFileNotFoundError < Error; end
+  class InvalidTypeError < Error; end
 
-  class EmptyView < Error; end
-  class UnknownViewType < Error; end
-  class MultipleViews < Error; end
-
-  class EmptyStyle < Error; end
-  class UnknownStyleType < Error; end
-  class MultipleStyles < Error; end
+  class EmptyViewError < Error; end
+  class UnknownViewTypeError < Error; end
+  class MultipleViewsError < Error; end
 end
 
 require_relative 'amber_component/version'
@@ -24,5 +22,6 @@ 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/props'
 require_relative 'amber_component/base'
 require_relative 'amber_component/railtie' if defined?(::Rails::Railtie)

data/lib/generators/amber_component/install_generator.rb

@@ -13,11 +13,30 @@ module ::AmberComponent
       # copy rake tasks
       def copy_tasks
         copy_file 'application_component.rb', 'app/components/application_component.rb'
+        copy_file 'application_component_test_case.rb', 'test/application_component_test_case.rb'
+        append_file 'test/test_helper.rb', "require_relative 'application_component_test_case'"
 
-        inject_into_file 'app/assets/stylesheets/application.css', after: "*= require_tree .\n" do
+        require_components_css_in 'app/assets/stylesheets/application.css'
+        require_components_css_in 'app/assets/stylesheets/application.scss'
+        require_components_css_in 'app/assets/stylesheets/application.sass'
+        require_components_css_in 'app/assets/stylesheets/application.css.scss'
+        require_components_css_in 'app/assets/stylesheets/application.css.sass'
+        require_components_css_in 'app/assets/stylesheets/application.scss.sass'
+        require_components_css_in 'app/assets/stylesheets/application.sass.scss'
+      end
+
+      private
+
+      # @param file_name [String]
+      # @return [void]
+      def require_components_css_in(file_name)
+        return unless ::File.exist? file_name
+
+        inject_into_file file_name, after: "*= require_tree .\n" do
           " *= require_tree ./../../components\n"
         end
       end
+
     end
   end
 end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'amber_component/test_helper'
+
+class ApplicationComponentTestCase < ::ActiveSupport::TestCase
+  include ::AmberComponent::TestHelper
+end

data/lib/generators/amber_component_generator.rb

@@ -7,12 +7,39 @@ class AmberComponentGenerator < ::Rails::Generators::NamedBase
   desc 'Generate a new component'
   source_root ::File.expand_path('templates', __dir__)
 
-  # copy rake tasks
-  def copy_tasks
+  # @return [Array<Symbol>]
+  VIEW_FORMATS = %i[html erb haml slim].freeze
+  # @return [Array<Symbol>]
+  STYLE_FORMATS = %i[css scss sass].freeze
+
+  class_option :view,
+               aliases: ['-v'],
+               desc: "Indicate what type of view should be generated eg. #{VIEW_FORMATS}"
+
+  class_option :css,
+               aliases: ['--style', '-c'],
+               desc: "Indicate what type of styles should be generated eg. #{STYLE_FORMATS}"
+
+  def generate_component
+    @view_format = (options[:view] || :html).to_sym
+    @view_format = :html if @view_format == :erb
+
+    @style_format = options[:css]&.to_sym
+
+    unless VIEW_FORMATS.include? @view_format
+      puts "No such view format as `#{@view_format}`"
+      return
+    end
+
+    if !@style_format.nil? && STYLE_FORMATS.include?(@style_format)
+      puts "No such css/style format as `#{@style_format}`"
+      return
+    end
+
     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"
+    create_stylesheet
+    create_view
   end
 
   def file_name
@@ -21,4 +48,29 @@ class AmberComponentGenerator < ::Rails::Generators::NamedBase
 
     "#{name}_component"
   end
+
+  private
+
+  # @return [void]
+  def create_view
+    case @view_format
+    when :slim
+      template 'view.slim.erb', "app/components/#{file_path}/view.slim"
+    when :haml
+      template 'view.haml.erb', "app/components/#{file_path}/view.haml"
+    else
+      template 'view.html.erb.erb', "app/components/#{file_path}/view.html.erb"
+    end
+  end
+
+  # @return [void]
+  def create_stylesheet
+    if (@style_format.nil? && defined?(::SassC)) || @style_format == :scss
+      template 'style.scss.erb', "app/components/#{file_path}/style.scss"
+    elsif @style_format == :sass
+      template 'style.sass.erb', "app/components/#{file_path}/style.sass"
+    else
+      template 'style.css.erb', "app/components/#{file_path}/style.css"
+    end
+  end
 end

data/lib/generators/component_generator.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require_relative 'amber_component_generator'
+
+# A Rails generator which creates a new Amber component.
+class ComponentGenerator < AmberComponentGenerator
+  source_root ::File.expand_path('templates', __dir__)
+end

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

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 class <%= class_name %> < ::ApplicationComponent
-  # Your code goes here
+  # Props that your component accepts
+  prop :description, default: -> { 'Default Description' }
 
   after_initialize do
+    # some initialization
     @time = ::Time.now
   end
 end

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

@@ -2,8 +2,16 @@
 
 require 'test_helper'
 
-class <%= class_name %>Test < ::ActiveSupport::TestCase
-  # test 'the truth' do
-  #   assert true
+class <%= class_name %>Test < ::ApplicationComponentTestCase
+  # For a full list of available assertions see
+  # https://rubydoc.info/github/jnicklas/capybara/Capybara/Node/Matchers
+
+  # test 'returns correct html' do
+  #   render do
+  #     <%= class_name %>.call
+  #   end
+
+  #   assert_text 'Hello from <%= class_name %>'
+  #   assert_selector "div.<%= singular_table_name %> p", text: 'Default Description'
   # end
 end

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

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

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

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

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

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

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

@@ -0,0 +1,9 @@
+.<%= singular_table_name %>
+  %h1
+    Hello from
+    %b
+      <%= class_name %>
+    , initialized at:
+    = @time
+  %p
+    = description

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

@@ -0,0 +1,8 @@
+<div class='<%= singular_table_name %>'>
+  <h1>
+    Hello from <b><%= class_name %></b>, initialized at: <%%= @time %>
+  </h1>
+  <p>
+    <%%= description %>
+  </p>
+</div>

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

@@ -0,0 +1,6 @@
+div.<%= singular_table_name %>
+  h1
+    | Hello from
+    b <%= class_name %>
+    | , initialized at: #{@time}
+  p = description

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amber_component
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Ruby-Amber
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-12 00:00:00.000000000 Z
+date: 2022-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -107,34 +107,6 @@ files:
 - 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
@@ -143,20 +115,30 @@ files:
 - lib/amber_component/helpers/class_helper.rb
 - lib/amber_component/helpers/component_helper.rb
 - lib/amber_component/helpers/css_helper.rb
+- lib/amber_component/minitest_test_case.rb
+- lib/amber_component/prop_definition.rb
+- lib/amber_component/props.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/test_helper.rb
 - lib/amber_component/typed_content.rb
 - lib/amber_component/version.rb
 - lib/amber_component/views.rb
 - lib/generators/amber_component/install_generator.rb
 - lib/generators/amber_component/templates/application_component.rb
+- lib/generators/amber_component/templates/application_component_test_case.rb
 - lib/generators/amber_component_generator.rb
+- lib/generators/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
+- lib/generators/templates/style.sass.erb
+- lib/generators/templates/style.scss.erb
+- lib/generators/templates/view.haml.erb
+- lib/generators/templates/view.html.erb.erb
+- lib/generators/templates/view.slim.erb
 homepage: https://github.com/amber-ruby/amber_component
 licenses:
 - MIT

data/docs/.bundle/config

@@ -1,2 +0,0 @@
----
-BUNDLE_BUILD__EVENTMACHINE: "--with-cppflags=-I/opt/homebrew/opt/openssl@3/include"

data/docs/.gitignore

@@ -1,5 +0,0 @@
-_site/
-.sass-cache
-.jekyll-cache
-.jekyll-metadata
-vendor

data/docs/404.html

@@ -1,25 +0,0 @@
----
-permalink: /404.html
-layout: default
----
-
-<style type="text/css" media="screen">
-  .container {
-    margin: 10px auto;
-    max-width: 600px;
-    text-align: center;
-  }
-  h1 {
-    margin: 30px 0;
-    font-size: 4em;
-    line-height: 1;
-    letter-spacing: -1px;
-  }
-</style>
-
-<div class="container">
-  <h1>404</h1>
-
-  <p><strong>Page not found :(</strong></p>
-  <p>The requested page could not be found.</p>
-</div>

data/docs/Gemfile

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-# Hello! This is where you manage which Jekyll version is used to run.
-# When you want to use a different version, change it below, save the
-# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
-#
-#     bundle exec jekyll serve
-#
-# This will help ensure the proper Jekyll version is running.
-# Happy Jekylling!
-gem 'jekyll', '~> 4.2.2'
-gem 'just-the-docs' # Theme for Jekyll docs.
-gem 'webrick'
-# This is the default theme for new Jekyll sites. You may change this to anything you like.
-gem 'minima', '~> 2.5'
-# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
-# uncomment the line below. To upgrade, run `bundle update github-pages`.
-# gem "github-pages", group: :jekyll_plugins
-# If you have any plugins, put them here!
-group :jekyll_plugins do
-  gem 'jekyll-feed', '~> 0.12'
-end
-
-# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
-# and associated library.
-platforms :mingw, :x64_mingw, :mswin, :jruby do
-  gem 'tzinfo', '~> 1.2'
-  gem 'tzinfo-data'
-end
-
-# Performance-booster for watching directories on Windows
-gem 'wdm', '~> 0.1.1', platforms: %i[mingw x64_mingw mswin]
-
-# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
-# do not have a Java counterpart.
-gem 'http_parser.rb', '~> 0.6.0', platforms: [:jruby]