amber_component 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 239144479c990df66cda6d83bd062bdcfd0b0affca32597ebd968d490f6817d8
-  data.tar.gz: 8d8cc882bceabcbff1cf16d0b5881274f55068a30b91acac98c2e108be248c0c
+  metadata.gz: f1809ef804fefeb8ed7e05b8d1056895f7068663b92b74b464b99bb611981e7c
+  data.tar.gz: 7a05630fb2c74850241378c1b2e176373258b0e3a63aa7eae26803fc0a7077d5
 SHA512:
-  metadata.gz: f06b5e9288c557ae52015f637111ae6a6b90f0402a72b63873cdc1c3aae14d114c921bec304dda68b6ffddc4e4cc98e27d8cac28d84ec2758eb6da1d4176db28
-  data.tar.gz: 8d950dcb6102a235f38078511705799a38956f94df12f8e5677f5d038c5adc598cf275ef2266c00f1ccfe9a54666793248afb076b982ea6858300692ce817776
+  metadata.gz: b554c4cbaafe3fd6e4cbebe34c4e99ea7d318e50aa38b599b87c35d72bf5a353e0099b0471d643543c6f6227275295f63c0f33432940d7d0de71b8ac29ddd488
+  data.tar.gz: 69ef4f133acd94753d9108b56ef44f601fd59435a53dadaf194905190f53db8dcc368dcd3c5da68cfcc027a8a27a4b6a33d99f40b3bb3985cf3c80ce9c79e8bc

data/.solargraph.yml

@@ -9,8 +9,7 @@ exclude:
 require: []
 domains: []
 reporters:
-- rubocop
-- require_not_found
+- typecheck:typed
 formatter:
   rubocop:
     cops: safe

data/CONTRIBUTING.md

@@ -72,9 +72,9 @@ $ gem install ffi -- --with-cflags="-fdeclspec"
 
 > Gem::Ext::BuildError: ERROR: Failed to build gem native extension.
 >
->    current directory: /Users/mateuszdrewniak/.rvm/gems/ruby-3.1.0@dupa/gems/puma-5.6.2/ext/puma_http11
+>    current directory: ~/.rvm/gems/ruby-3.1.0@dupa/gems/puma-5.6.2/ext/puma_http11
 >
-> /Users/mateuszdrewniak/.rvm/rubies/ruby-3.1.0/bin/ruby -I /Users/mateuszdrewniak/.rvm/rubies/ruby-3.1.0/lib/ruby/3.1.0 -r ./siteconf20220219-40641-4uxhq6.rb extconf.rb --with-cflags\=-Wno-error\=implicit-function-declaration
+> ~/.rvm/rubies/ruby-3.1.0/bin/ruby -I ~/.rvm/rubies/ruby-3.1.0/lib/ruby/3.1.0 -r ./siteconf20220219-40641-4uxhq6.rb extconf.rb --with-cflags\=-Wno-error\=implicit-function-declaration
 >
 > checking for BIO_read() in -lcrypto... *** extconf.rb failed ***
 >

data/Gemfile

@@ -13,7 +13,7 @@ gem 'git'
 gem 'haml'
 gem 'rubocop', '~> 1.21'
 gem 'sassc'
-gem 'solargraph', '~> 0.45.0'
+gem 'solargraph'
 gem 'yard'
 
 # Testing dependencies

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    amber_component (0.0.3)
+    amber_component (0.0.5)
       actionview (>= 6)
       activemodel (>= 6)
       activesupport (>= 6)
@@ -67,13 +67,13 @@ GEM
     method_source (1.0.0)
     mini_portile2 (2.8.0)
     minitest (5.16.2)
-    nokogiri (1.13.8)
+    nokogiri (1.13.9)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.13.8-arm64-darwin)
+    nokogiri (1.13.9-arm64-darwin)
       racc (~> 1.4)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     racc (1.6.0)
     rack (2.2.4)
@@ -98,17 +98,17 @@ GEM
     reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.5)
-    rubocop (1.32.0)
+    rubocop (1.36.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.19.1, < 2.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.19.1)
+    rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
@@ -124,7 +124,7 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    solargraph (0.45.0)
+    solargraph (0.46.0)
       backport (~> 1.2)
       benchmark
       bundler (>= 1.17.2)
@@ -144,7 +144,7 @@ GEM
     tilt (2.0.11)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.2.0)
+    unicode-display_width (2.3.0)
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)
@@ -168,8 +168,8 @@ DEPENDENCIES
   shoulda-context (~> 2.0)
   simplecov
   simplecov-cobertura
-  solargraph (~> 0.45.0)
+  solargraph
   yard
 
 BUNDLED WITH
-   2.3.14
+   2.3.7

data/README.md

@@ -9,13 +9,13 @@
 
 # AmberComponent
 
-AmberComponent is a simple component library which seamlessly hooks into your Rails project and allows you to create simple backend components. They work like mini controllers which are bound with their view.
+AmberComponent is a simple component library which seamlessly hooks into your Rails project and allows you to create simple backend components. They work like mini controllers which are bound with their view and stylesheet.
 
 Created by [Garbus Beach](https://github.com/garbusbeach) and [Mateusz Drewniak](https://github.com/Verseth).
 
 ## Getting started
 
-You can read a lot more about AmberComponent in its [official docs](https://ambercomponent.com). 
+You can read a lot more about AmberComponent in its [official docs](https://ambercomponent.com).
 
 ## Installation
 
@@ -27,14 +27,337 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install amber_component
 
+If you're using a Rails application there's an installation generator that you should run:
+
+```sh
+$ bin/rails generate amber_component:install
+```
+
 ## Usage
 
-If you're using a Rails application there's an installation generator that you should run:
+## Components
+
+Components are located under `app/components`.
+
+Every component consists of:
+- a Ruby file which defines its properties, encapsulates logic and may implement helper methods (like a controller)
+- a view/template file (html.erb, haml, slim etc.)
+- a style file (css, scss, sass etc.)
+
+An individual component which implements a button may look like this.
+
+```ruby
+# app/components/button_component.rb
+
+class ButtonComponent < AmberComponent::Base
+  prop :label, required: true
+end
+```
+
+```html
+<!-- app/components/button_component/view.html.erb -->
+
+<div class="button_component">
+    <%= label %>
+</div>
+```
+
+```scss
+// app/components/button_component/style.scss
+
+.button_component {
+    background-color: indigo;
+    border-radius: 1rem;
+    transition-duration: 500ms;
+
+    &:hover {
+        background-color: blue;
+    }
+}
+```
+
+You can render this component in other components or in a Rails view.
+
+```html
+<!-- app/controller/foo/index.html.erb -->
+
+<h1>We're inside FooController</h1>
+
+<!-- using a helper method -->
+<%= button_component label: 'Click me!' %>
+<!-- calling a method on the component class -->
+<%= ButtonComponent.call label: 'Click me!' %>
+```
+
+Or even directly in Ruby
+
+```ruby
+# Calling a method on the component class. Outputs an HTML string.
+ButtonComponent.call label: 'Click me!'
+#=> '<div class="button_component">Click me!</div>'
+```
+
+### Rails helpers inside component templates
+
+Component views/template files can make use
+of all ActionView helpers and Rails route helpers.
+
+This makes component views very flexible and convenient.
+
+```erb
+<!-- app/components/login_form_component/view.html.erb -->
+
+<%= form_with url: sign_up_path, class: "login_form_component" do |f| %>
+  <%= f.label :first_name %>
+  <%= f.text_field :first_name %>
+
+  <%= f.label :last_name %>
+  <%= f.text_field :last_name %>
+
+  <%= f.label :email, "Email Address" %>
+  <%= f.text_field :email %>
+
+  <%= f.label :password %>
+  <%= f.password_field :password %>
+
+  <%= f.label :password_confirmation, "Confirm Password" %>
+  <%= f.password_field :password_confirmation %>
+
+  <%= f.submit "Create account" %>
+<% end %>
+```
+
+### Component properties
+
+There is a neat prop DSL.
+
+```ruby
+# app/components/comment_component.rb
+
+class CommentComponent < ApplicationComponent
+    # will raise an error when not present
+    prop :body, required: true
+    # will raise an error when an object of a different
+    # class is received (uses `is_a?`)
+    prop :author, type: User, allow_nil: true
+    # the default value
+    prop :date, default: -> { DateTime.now }
+end
+```
+
+Props can be passed as keyword arguments
+to the `::call` method of the component class
+or the helper method.
+
+```ruby
+CommentComponent.call body: 'Foo bar', author: User.first
+# only in views and other components
+comment_component body: 'Foo bar', author: User.first
+```
+
+### Overriding prop getters and setters
+
+Getters and setters for properties are
+defined in a module which means that you can override them and call them with `super`.
+
+```ruby
+# app/components/priority_icon_component.rb
+
+class PriorityIconComponent < ApplicationComponent
+    PriorityStruct = Struct.new :icon, :color
+
+    PRIORITY_MAP = {
+        low: PriorityStruct.new('fa-solid fa-chevrons-down', 'green'),
+        medium: PriorityStruct.new('fa-solid fa-chevron-up', 'yellow'),
+        high: PriorityStruct.new('fa-solid fa-chevrons-up', 'red')
+    }
+
+    prop :severity, default: -> { :low }
+
+    def severity=(val)
+      # super will call the original
+      # implementation of the setter
+      super(PRIORITY_MAP[val])
+    end
+end
+```
+
+```html
+<!-- app/components/priority_icon_component/view.html.erb -->
+
+<i style="color: <%= severity&.color %>;" class="<%= severity&.icon %>"></i>
+```
+
+### Helper methods
+
+Defining helper methods which are available
+in the template is extremely easy.
+
+Just define a method on the component class.
+
+```ruby
+# app/components/comment_component.rb
+
+class CommentComponent < ApplicationComponent
+    # you can also include helper modules
+    include SomeHelper
+
+    prop :body, required: true
+    prop :author, type: Author, allow_nil: true
+    prop :date, default: -> { DateTime.now }
+
+    private
+
+    def humanized_date
+        date.strftime '%Y-%m-%d %H:%M'
+    end
+
+    def author_name
+        author&.name || 'Unknown'
+    end
+
+    def author_avatar
+        author&.avatar_url || User.placeholder_avatar_url
+    end
+end
+```
+
+```html
+<!-- app/components/comment_component/view.html.erb -->
+
+<div class="comment_component">
+    <div class="comment_header">
+        <img src="<%= author_avatar %>" alt="<%= author_name %> avatar">
+
+        <div><%= author_name %></div>
+        <div class="comment_date"><%= humanized_date %></div>
+    </div>
+
+    <div class="comment_content">
+        <%= body %>
+    </div>
+</div>
+```
+
+### Nested components
+
+It's possible to nest components or provide
+custom HTML to a component.
+
+This works similarly to React's `props.children`.
+
+To render the passed nested content call `yield.html_safe` somewhere inside the template/view.
+
+```ruby
+# app/components/modal_component.rb
+
+class ModalComponent < ApplicationComponent
+    prop :id, required: true
+    prop :title, required: true
+end
+```
+
+```html
+<!-- app/components/modal/view.html.erb -->
+
+<div id="<%= id %>" class="modal_component">
+    <div class="model_header">
+        <%= title %>
+    </div>
+
+    <div class="modal_body">
+        <!-- nested content will be rendered here -->
+        <%= yield.html_safe %>
+    </div>
+
+    <div class="modal_footer">
+        <div class="modal_close_button"></div>
+    </div>
+<div>
+```
+
+You can pass a body to this modal by passing
+a block.
+
+```erb
+<!-- app/controller/tasks/show.html.erb -->
+
+<%= ModalComponent.call id: 'update-task-modal' title: 'Update the task' do %>
+    <h2>This is your task!</h2>
+    <%= form_with model: @task do |f| %>
+        <%= f.text_field :name %>
+        <%= f.text_area :description %>
+        <%= f.submit %>
+    <% end %>
+<% end %>
+```
+
+Note that this will raise an error when no block/nested content is provided.
+
+In order to render nested content
+only when it is present (will work without nested content)
+you can use `yield.html_safe if block_given?`
+
+In general `block_given?` will return `true` when a block/nested content is present, otherwise `false`.
+
+### Components with namespaces
+
+Components may be defined inside multiple modules/namespaces.
+
+```ruby
+# app/components/sign_up/button_component.rb
+
+class SignUp::ButtonComponent < AmberComponent::Base
+  prop :label, required: true
+end
+```
+
+```html
+<!-- app/components/sign_up/button_component/view.html.erb -->
+
+<div class="sign_up_button_component">
+    <%= label %>
+</div>
+```
+
+```scss
+// app/components/sign_up/button_component/style.scss
+
+.sign_up_button_component {
+    background-color: indigo;
+    border-radius: 1rem;
+    transition-duration: 500ms;
+
+    &:hover {
+        background-color: blue;
+    }
+}
+```
+
+You can render such a component by calling the `::call` method
+on its class, or by using the helper method defined on its parent module.
+
+```ruby
+SignUp::ButtonComponent.call label: 'Sign up!'
+SignUp.button_component label: 'Sign up!'
+```
+
+### Generating Components
+
+You an generate new components by running
 
 ```sh
-$ rails generate amber_component:install
+$ bin/rails generate component foo_bar
 ```
 
+or
+
+```sh
+$ bin/rails generate component FooBar
+```
+
+This will generate a new component in `app/components/foo_bar_component.rb` along with a view, stylesheet and test file.
+
 ## Contribute
 
 Do you want to contribute to AmberComponent? Open the issues page and check for the help wanted label! But before you start coding, please read our [Contributing Guide](https://github.com/amber-ruby/amber_component/blob/main/CONTRIBUTING.md).

data/lib/amber_component/base.rb

@@ -48,6 +48,8 @@ module ::AmberComponent
     extend  Assets::ClassMethods
     include Rendering::InstanceMethods
     extend  Rendering::ClassMethods
+    include Props::InstanceMethods
+    extend  Props::ClassMethods
 
     class << self
       include ::Memery
@@ -67,37 +69,51 @@ module ::AmberComponent
       # @return [void]
       def inherited(subclass)
         super
-        # @type [Module]
-        method_body = proc do |**kwargs, &block|
+        method_body = lambda do |**kwargs, &block|
           subclass.render(**kwargs, &block)
         end
         parent_module = subclass.module_parent
 
         if parent_module.equal?(::Object)
           method_name = subclass.name
-          define_helper_method(subclass, Helpers::ComponentHelper, method_name, method_body)
           define_helper_method(subclass, Helpers::ComponentHelper, method_name.underscore, method_body)
           return
         end
 
         method_name = subclass.const_name
-        define_helper_method(subclass, parent_module.singleton_class, method_name, method_body)
         define_helper_method(subclass, parent_module.singleton_class, method_name.underscore, method_body)
       end
 
-      # @param component [Class]
+      # Gets or defines an anonymous module that
+      # will store all dynamically generated helper methods
+      # for the received module/class.
+      #
       # @param mod [Module, Class]
+      # @return [Module]
+      def helper_module(mod)
+        ivar_name = :@__amber_component_helper_module
+        mod.instance_variable_get(ivar_name)&.then { return _1 }
+
+        helper_mod = mod.instance_variable_set(ivar_name, ::Module.new)
+        mod.include helper_mod
+        helper_mod
+      end
+
+      # Defines an instance method on the given `mod` Module/Class.
+      #
+      # @param component [Class]
+      # @param target_mod [Module, Class]
       # @param method_name [String, Symbol]
       # @param body [Proc]
-      def define_helper_method(component, mod, method_name, body)
-        mod.define_method(method_name, &body)
+      def define_helper_method(component, target_mod, method_name, body)
+        helper_module(target_mod).define_method(method_name, &body)
 
         return if ::ENV['RAILS_ENV'] == 'production'
 
-        ::Warning.warn <<~WARN if mod.instance_methods.include?(method_name)
+        ::Warning.warn <<~WARN if target_mod.instance_methods.include?(method_name)
           #{caller(0, 1).first}: warning:
-              `#{component}` shadows the name of an already existing `#{mod}` method `#{method_name}`.
-              Consider renaming this component, because the original method will be overwritten.
+              `#{component}` shadows the name of an already existing `#{target_mod}` method `#{method_name}`.
+              Consider renaming this component, because the original method will be overridden.
         WARN
       end
     end
@@ -105,9 +121,12 @@ module ::AmberComponent
     define_model_callbacks :initialize, :render
 
     # @param kwargs [Hash{Symbol => Object}]
+    # @raise [AmberComponent::MissingPropsError] when required props are missing
     def initialize(**kwargs)
       run_callbacks :initialize do
-        bind_variables(kwargs)
+        next if bind_props(kwargs)
+
+        bind_instance_variables(kwargs)
       end
     end
 
@@ -115,7 +134,7 @@ module ::AmberComponent
 
     # @param kwargs [Hash{Symbol => Object}]
     # @return [void]
-    def bind_variables(kwargs)
+    def bind_instance_variables(kwargs)
       kwargs.each do |key, value|
         instance_variable_set("@#{key}", value)
       end

data/lib/amber_component/helpers/component_helper.rb

@@ -7,6 +7,7 @@ module ::AmberComponent
     # Contains methods for quickly rendering
     # components defined under the root namespace `Object`.
     module ComponentHelper
+      @__amber_component_helper_module = self
     end
   end
 end

data/lib/amber_component/minitest_test_case.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+
+module AmberComponent
+  # A base class for component tests with Minitest
+  class MinitestTestCase < ::Minitest::Test
+    include TestHelper
+  end
+end

data/lib/amber_component/prop_definition.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module ::AmberComponent
+  # Internal class which represents a property
+  # on a component class.
+  class PropDefinition
+    # @return [Symbol]
+    attr_reader :name
+    # @return [Class, nil]
+    attr_reader :type
+    # @return [Boolean]
+    attr_reader :required
+    # @return [Object, Proc, nil]
+    attr_reader :default
+    # @return [Boolean]
+    attr_reader :allow_nil
+
+    # @param name [Symbol]
+    # @param type [Class, nil]
+    # @param required [Boolean]
+    # @param default [Object, Proc, nil]
+    # @param allow_nil [Boolean]
+    def initialize(name:, type: nil, required: false, default: nil, allow_nil: false)
+      @name = name
+      @type = type
+      @required = required
+      @default = default
+      @allow_nil = allow_nil
+    end
+
+    alias required? required
+    alias allow_nil? allow_nil
+
+    # @return [Boolean]
+    def type?
+      !@type.nil?
+    end
+
+    # @return [Boolean]
+    def default?
+      !@default.nil?
+    end
+
+    # Evaluate the default value if it's a `Proc`
+    # and return the result.
+    #
+    # @return [Object]
+    def default!
+      return @default.call if @default.is_a?(::Proc)
+
+      @default
+    end
+  end
+end