Merge pull request #456 from matestack/next-release

1.0.0 Release

Author: jonasjabari

Gemfile

@@ -25,12 +25,12 @@ group :development, :test do
   gem 'simplecov', require: false, group: :test
   gem 'byebug'
   gem 'webmock'
-  gem 'pry-rails'
-  gem 'pry-byebug'
   gem 'turbolinks'
 end
 
 group :test do
+  gem 'pry-rails'
+  gem 'pry-byebug'
   gem "generator_spec"
   gem "rspec-retry" # repeating flaky tests
   gem "rspec-wait", "~> 0.0.9"

README.md

@@ -1,15 +1,13 @@
-![](https://github.com/matestack/matestack-ui-core/workflows/specs/badge.svg)
+[![Specs](https://github.com/matestack/matestack-ui-core/workflows/specs/badge.svg)](https://github.com/matestack/matestack-ui-core/actions)
 [![Gitter](https://badges.gitter.im/basemate/community.svg)](https://gitter.im/basemate/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 [![Gem Version](https://badge.fury.io/rb/matestack-ui-core.svg)](https://badge.fury.io/rb/matestack-ui-core)
 [![Docs](https://img.shields.io/badge/docs-matestack-blue.svg)](https://docs.matestack.io/docs/guides/1-installation/README.md)
+[![Twitter Follow](https://img.shields.io/twitter/follow/matestack.svg?style=social)](https://twitter.com/matestack) 
 
 ![matestack logo](./logo.png)
 
 # matestack-ui-core
 
-**Note:**
-The master branch is representing the latest release. Currently this is the `1.0.0.rc.1` release. We will publish `1.0.0` in September after a bit more testing.
-
 ## Escape the frontend hustle & easily create interactive web apps in pure Ruby
 
 `matestack-ui-core` is a Rails engine for Ruby on Rails developers.
@@ -42,7 +40,6 @@ Documentation can be found [here](https://docs.matestack.io/docs/guides/1-instal
 
 Changelog can be found [here](./CHANGELOG.md)
 
-
 ## Community
 
 As a low-barrier feedback channel for our early users, we have set up a Gitter chat that can be found [here](https://gitter.im/basemate/community). You are very welcome to ask questions and send us feedback there!

app/concepts/matestack/ui/core/isolated/isolated.rb

@@ -4,7 +4,7 @@ class Isolated < Matestack::Ui::Core::Component::Dynamic
 
     def initialize(*args)
       super
-      @public_options = args.map { |hash| hash[:public_options] }[0]
+      @public_options = args.map { |hash| hash&.dig(:public_options) }[0]
     end
 
     def public_options

app/lib/matestack/ui/core/html_attributes.rb

@@ -19,6 +19,7 @@ def self.included(base)
   module ClassMethods
 
     def inherited(subclass)
+      super
       subclass.html_attributes *self.allowed_html_attributes
     end
 

app/lib/matestack/ui/core/properties.rb

@@ -18,21 +18,63 @@ def self.included(base)
   module Initializer
     def initialize(model=nil, options={})
       options = model.dup if options.empty? && model.is_a?(Hash)
-      required_hooks(options)
-      optional_hooks(options)
+      # required_hooks(options)
+      # optional_hooks(options)
+      set_values(options) unless options[:skip_set_values]
       super
     end
   end
 
   module ClassMethods
+
+    def inherited(subclass)
+      super
+      # self.new(nil, skip_set_values: true)
+      subclass.property_keys *self.all_property_keys
+      subclass.all_required_properties.concat(self.all_required_properties)
+      subclass.created_properties.concat(self.created_properties)
+    end
+    
+    # contains all property keys, or property hashes regardless of wheter they are optional or required
+    # used in order to initialize values of properties correctly for subclasses and make properties inheritable
+    def all_property_keys
+      @all_properties.flatten!&.uniq! if defined? @all_properties
+      @all_properties ||= []
+    end
+
+    def all_required_properties
+      @all_required_properties ||= []
+    end
+
+    def created_properties
+      @created_properties ||= []
+    end
+
+    # add property keys to array containing all property keys
+    def property_keys(*attributes)
+      attributes.each do |attribute|
+        if attribute.is_a?(Hash)
+          attribute.each do |temp|
+            all_property_keys.push({ "#{temp.first}": temp.last})
+          end
+        else
+          all_property_keys.push(attribute) 
+        end
+      end
+    end
+
     # define optinoal properties for custom components with `optional :foo, :bar`
     def optional(*properties)
+      property_keys *properties
       add_properties_to_list(optional_properties, properties)
+      optional_hooks
     end
 
     # define required properties for custom components with `requires :title, :foo, :bar`
     def requires(*properties)
+      property_keys *properties
       add_properties_to_list(requires_properties, properties)
+      required_hooks
     end
 
     def add_properties_to_list(list, properties)
@@ -47,42 +89,73 @@ def add_properties_to_list(list, properties)
 
     # array of properties created from the component
     def optional_properties
-      @component_properties ||= []
+      @optional_properties ||= []
     end
 
     # array of required properties from the component
     def requires_properties
       @requires_properties ||= []
     end
-  end
 
-  def optional_hooks(options)
-    self.class.optional_properties.compact.each do |prop|
-      if prop.is_a? Array
-        hash = prop.flatten
-        options[hash.last[:as]] = options[hash.first]
-        prop = hash.last[:as]
+    def optional_hooks
+      self.optional_properties.compact.each do |prop|
+        prop = extract_property_key({}, prop)
+        define_getter_and_setter_for_property(prop)
       end
-      raise PropertyOverwritingExistingMethodException, "Optional property #{prop} would overwrite already defined instance method for #{self.class}" if self.respond_to? prop
-      send(:define_singleton_method, prop) do 
-        options[prop]
+    end
+
+    def required_hooks
+      self.requires_properties.compact.each do |prop|
+        prop = extract_property_key({}, prop)
+        self.all_required_properties.push(prop).uniq!
+        define_getter_and_setter_for_property(prop)
       end
     end
-  end
 
-  def required_hooks(options)
-    self.class.requires_properties.compact.each do |prop|
-      if prop.is_a? Array
+    def extract_property_key(options, prop)
+      if prop.is_a?(Array) || prop.is_a?(Hash)
         hash = prop.flatten
-        options[hash.last[:as]] = options[hash.first]
         prop = hash.last[:as]
       end
-      raise PropertyMissingException, "Required property #{prop} is missing for #{self.class}" if options[prop].nil?
-      raise PropertyOverwritingExistingMethodException, "Required property #{prop} would overwrite already defined instance method for #{self.class}" if self.respond_to? prop
-      send(:define_singleton_method, prop) do
-        options[prop]
+      prop
+    end
+
+    def define_getter_and_setter_for_property(prop)
+      self.created_properties.push(prop)
+      self.send(:define_method, prop) do 
+        self.instance_variable_get(:"@#{prop}")
+      end
+      self.send(:define_method, :"#{prop}=") do |value|
+        self.instance_variable_set(:"@#{prop}", value)
+      end
+    end
+
+    def method_added(name)
+      if all_property_keys.include?(name) && !created_properties.include?(name)
+        raise PropertyOverwritingExistingMethodException, "Property \"#{name}\" would overwrite already defined instance method for #{self}"
+      end
+    end
+  end
+
+  def set_values(options)
+    self.class.all_property_keys.compact.each do |prop|
+      value_key = prop
+      prop = extract_property_key(options, prop)
+      if self.class.all_required_properties.include?(prop) && options[prop].nil?
+        raise PropertyMissingException, "Required property #{prop} is missing for #{self.class}" 
       end
+      send(:"#{prop}=", options[prop])
+    end
+  end
+
+  # returns property key and sets alias if hash with as option is given
+  def extract_property_key(options, prop)
+    if prop.is_a?(Array) || prop.is_a?(Hash)
+      hash = prop.flatten
+      options[hash.last[:as]] = options[hash.first]
+      prop = hash.last[:as]
     end
+    prop
   end
 
 end

docs/guides/1-installation/README.md

@@ -27,7 +27,7 @@ Rails 6+ apps, by default, use webpacker, rails 5 apps, by default, use the asse
 Add 'matestack-ui-core' to your `package.json` by running:
 
 ```
-$ yarn add https://github.com/matestack/matestack-ui-core#v1.0.0.rc.1
+$ yarn add https://github.com/matestack/matestack-ui-core#v1.0.0
 $ yarn install
 ```
 

lib/matestack/ui/core/version.rb

@@ -1,7 +1,7 @@
 module Matestack
   module Ui
     module Core
-      VERSION = '1.0.0.rc.1'
+      VERSION = '1.0.0'
     end
   end
 end

package.json

@@ -1,6 +1,6 @@
 {
   "name": "matestack-ui-core",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0",
   "main": "app/javascript/matestack-ui-core",
   "private": true,
   "dependencies": {

spec/dummy/app/matestack/components/fancy/card.rb

@@ -1,4 +1,5 @@
 class Components::Fancy::Card < Matestack::Ui::StaticComponent
 
+  optional :foobar
 
 end