amber_component 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1809ef804fefeb8ed7e05b8d1056895f7068663b92b74b464b99bb611981e7c
-  data.tar.gz: 7a05630fb2c74850241378c1b2e176373258b0e3a63aa7eae26803fc0a7077d5
+  metadata.gz: d81663eb6f3cd153cb0a277a0114f8cce4e2140f40685f23a688a60c8ce86226
+  data.tar.gz: 32abb3383e052466435f318e1f8c4010adfa5f3d7e93e588e7e2842ff7cd59e6
 SHA512:
-  metadata.gz: b554c4cbaafe3fd6e4cbebe34c4e99ea7d318e50aa38b599b87c35d72bf5a353e0099b0471d643543c6f6227275295f63c0f33432940d7d0de71b8ac29ddd488
-  data.tar.gz: 69ef4f133acd94753d9108b56ef44f601fd59435a53dadaf194905190f53db8dcc368dcd3c5da68cfcc027a8a27a4b6a33d99f40b3bb3985cf3c80ce9c79e8bc
+  metadata.gz: 4a3df277a91914b6a148cc72c1b3981f78c420e773b408c8555a8915424d11667c804f113c2a1fd76bce751083607086ab660f1634855fcec686bc433b875c12
+  data.tar.gz: 330efd82e1589a4804f72f4dcb1df1f9a9b90696ce2dfb542c69b91dd1b0a5b7797736c9fa8ce461f73ff7bb16a3966a8ed00b8340c6d047d289acde976240cc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    amber_component (0.0.5)
+    amber_component (1.0.0)
       actionview (>= 6)
       activemodel (>= 6)
       activesupport (>= 6)
@@ -94,21 +94,21 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     rchardet (1.8.0)
-    regexp_parser (2.5.0)
+    regexp_parser (2.6.0)
     reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.5)
-    rubocop (1.36.0)
+    rubocop (1.38.0)
       json (~> 2.3)
       parallel (~> 1.10)
       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.20.1, < 2.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
+    rubocop-ast (1.23.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.46.0)
+    solargraph (0.47.2)
       backport (~> 1.2)
       benchmark
       bundler (>= 1.17.2)

data/README.md

@@ -283,12 +283,14 @@ a block.
 <!-- app/controller/tasks/show.html.erb -->
 
 <%= ModalComponent.call id: 'update-task-modal' title: 'Update the task' do %>
+    <!-- You can provide HTML and render other components -->
     <h2>This is your task!</h2>
     <%= form_with model: @task do |f| %>
         <%= f.text_field :name %>
         <%= f.text_area :description %>
         <%= f.submit %>
     <% end %>
+    <%= OtherComponent.call some: 'prop' %>
 <% end %>
 ```
 
@@ -299,6 +301,8 @@ 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`.
+You can use it to render content conditionally based on
+whether nested content is present.
 
 ### Components with namespaces
 
@@ -358,6 +362,99 @@ $ 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.
 
+### Testing Components
+
+### Rails
+
+After setting up this gem with the rails generator
+`rails generate amber_component:install` a new abstract
+test class will be available called `ApplicationComponentTestCase`.
+
+It provides a handful of helper methods to make it
+easier to inspect the rendered HTML.
+
+A simple test file may look like this:
+
+```ruby
+# test/components/foo_component_test.rb
+
+require 'test_helper'
+
+class FooComponentTest < ApplicationComponentTestCase
+    test 'render correct HTML' do
+        # Specify what the assertions are supposed to
+        # check against.
+        #
+        # There can be multiple renders in one test
+        # but they override the previous one.
+        # So there is only one rendered component
+        # at any given time.
+        render do
+            FooComponent.call some: 'prop'
+        end
+
+        # Assertions on the rendered HTML
+
+        # Use a CSS selector
+        assert_selector ".foo_component span.my_class", text: 'Some Text'
+        # Check text
+        assert_text 'Amber Component is awesome!'
+    end
+end
+```
+
+A full list of available assertions can be found [here](https://rubydoc.info/github/jnicklas/capybara/Capybara/Node/Matchers).
+
+### Non Rails
+
+There is a test case class for minitest. You can
+access it by requiring `'amber_component/minitest_test_case'`.
+
+It has the same assertion methods as the Rails test case class.
+It requires [capybara](https://github.com/teamcapybara/capybara) to be installed and present in the Gemfile.
+
+A full list of available assertions can be found [here](https://rubydoc.info/github/jnicklas/capybara/Capybara/Node/Matchers).
+
+```ruby
+require 'amber_component/minitest_test_case'
+
+class FooComponentTest < AmberComponent::MinitestTestCase
+    def test_render_correct_html
+        # Specify what the assertions are supposed to
+        # check against.
+        #
+        # There can be multiple renders in one test
+        # but they override the previous one.
+        # So there is only one rendered component
+        # at any given time.
+        render do
+            FooComponent.call some: 'prop'
+        end
+
+        # Assertions on the rendered HTML
+
+        # Use a CSS selector
+        assert_selector ".foo_component span.my_class", text: 'Some Text'
+        # Check text
+        assert_text 'Amber Component is awesome!'
+    end
+end
+```
+
+There is also a helper module which provides all of these assertions
+under `'amber_component/test_helper'`.
+
+```ruby
+require 'amber_component/test_helper'
+
+class MyAbstractTestCase < ::Minitest::Test
+    include ::AmberComponent::TestHelper
+end
+```
+
+Note that this module has only been tested with minitest and rails test suites,
+so it may require overriding or implementing a few methods to work with other test suites.
+
 ## 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/props.rb

@@ -75,7 +75,7 @@ module ::AmberComponent
     module InstanceMethods
       private
 
-      # @param props [Hash{Symbol => Object}]
+      # @param kwargs [Hash{Symbol => Object}]
       def initialize(**kwargs)
         bind_props(kwargs)
       end

data/lib/amber_component/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amber_component
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Ruby-Amber