amber_component 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 239144479c990df66cda6d83bd062bdcfd0b0affca32597ebd968d490f6817d8
-  data.tar.gz: 8d8cc882bceabcbff1cf16d0b5881274f55068a30b91acac98c2e108be248c0c
+  metadata.gz: 45f702b26ec801eb7f67fa45e14c4fac035ff31d9ad6602418b7faa15c8e6004
+  data.tar.gz: 404f922961c15d865144d8f284511f0b93718bc85f93a1fea1c1b013aa6d815f
 SHA512:
-  metadata.gz: f06b5e9288c557ae52015f637111ae6a6b90f0402a72b63873cdc1c3aae14d114c921bec304dda68b6ffddc4e4cc98e27d8cac28d84ec2758eb6da1d4176db28
-  data.tar.gz: 8d950dcb6102a235f38078511705799a38956f94df12f8e5677f5d038c5adc598cf275ef2266c00f1ccfe9a54666793248afb076b982ea6858300692ce817776
+  metadata.gz: 17df8b345dade33fb27c5167b9ee7d17788b2092ecbff5aeb2f6fbeb12a6dd91813e7c2aa9c52b42aafea6e5965869630960b64c1d3da5be3365d4e3f8702148
+  data.tar.gz: ec46b84d953e9efcc4ae0a36e68f0a733bfd8e76f518eee3cae2c33a655df3be9ec592b09cd8ade8b88707934e55004d03c62c2a48a2152690edd86910b4cd2e

data/.solargraph.yml

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

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.4)
       actionview (>= 6)
       activemodel (>= 6)
       activesupport (>= 6)
@@ -73,7 +73,7 @@ GEM
     nokogiri (1.13.8-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,7 +168,7 @@ DEPENDENCIES
   shoulda-context (~> 2.0)
   simplecov
   simplecov-cobertura
-  solargraph (~> 0.45.0)
+  solargraph
   yard
 
 BUNDLED WITH

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/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

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/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.4'
 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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amber_component
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 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-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -143,6 +143,8 @@ 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/prop_definition.rb
+- lib/amber_component/props.rb
 - lib/amber_component/railtie.rb
 - lib/amber_component/rendering.rb
 - lib/amber_component/template_handler.rb