material 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c02e2bc551e3197f2d3241ee71c54e0c225fbefe64089e4a978ab85d53dd535
-  data.tar.gz: fdaa66bcb6806156845d481a77ae62757d0b626c84fcc02e950ed929f9660226
+  metadata.gz: '021836dc0d87cd597826b893a04c6a95640fbccfc2f289c518624e19a962fb38'
+  data.tar.gz: d6afc3531a65a9d63e6570f9cc24d63219c23ed0c8154a44062e0924df6f0509
 SHA512:
-  metadata.gz: 1154fe53ffac761f9b90673ddd8ab568e5d7362d41bc7125c380a1e0763ba2ca952facfe491481485e8cf6d5be34da82633bd8d35dc8f317865694dfbff785dc
-  data.tar.gz: 2d076a62bdbb6fefa9b349de29526304fb561324e1d024909275406ab4f5eb1bca21c88872477c69d33595536c937e9b1857d560b7f4c18c8f4fa89fef7cdb68
+  metadata.gz: a13e04ba8415a4c8e48ab3adf31e935c2de502a967cd7f9c616668e58719ba597eea81b4f5f2ff27813704ebc0bfd86bdfc4e3a99d8dc44528ec46d5f814eb3a
+  data.tar.gz: 5b67cf7d691fd845a8dd704eb3bb55f7c39400d35d5d566fcfd7523232dd386fec217e2938d59407bd237a5488fde655008846f8a08d21cb7d3e51fd03565743

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Eric Garside
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Material
+
+An extensible and lightweight object which defines how your objects are viewed.
+
+[![Gem Version](https://badge.fury.io/rb/material.svg)](https://badge.fury.io/rb/material)
+[![Build Status](https://semaphoreci.com/api/v1/freshly/material/branches/develop/badge.svg)](https://semaphoreci.com/freshly/material)
+[![Maintainability](https://api.codeclimate.com/v1/badges/eca5499715d9a32c5616/maintainability)](https://codeclimate.com/github/Freshly/material/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/eca5499715d9a32c5616/test_coverage)](https://codeclimate.com/github/Freshly/material/test_coverage)
+
+* [Material](#material)
+  * [Installation](#installation)
+  * [Usage](#usage)
+  * [Development](#development)
+  * [Contributing](#contributing)
+  * [License](#license)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'material'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install material
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Freshly/material.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/material/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Material
+  class Base < Spicerack::AttributeObject
+    include Material::Components
+    include Material::Core
+    include Material::Icon
+    include Material::Text
+    include Material::Page
+    include Material::For
+
+    def self.for(object)
+      material_class_for(object, "Material")
+    end
+  end
+end

data/lib/material/concerns/components.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Components are value objects which abstract the storage of configuration data for various parts of a material.
+module Material
+  module Components
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_components, instance_writer: false, default: {}
+    end
+
+    class_methods do
+      def inherited(base)
+        dup = _components.dup
+        base._components = dup.each { |k, v| dup[k] = v.dup }
+        super
+      end
+
+      private
+
+      def register_component(key, **options, &block)
+        _components[key] = Component.new(**options, &block)
+        define_component_configurator(key)
+        define_component_reader(key)
+        define_component_value_reader(key)
+        define_component_predicate(key)
+      end
+
+      def define_component_configurator(key)
+        define_singleton_method("define_#{key}".to_sym) do |**options, &block|
+          _components[key].configure(**options, &block)
+        end
+      end
+
+      def define_component_reader(key)
+        method_name = "#{key}_component".to_sym
+        define_singleton_method(method_name) { _components[key] }
+        delegate method_name, to: :class
+      end
+
+      def define_component_value_reader(key)
+        method_name = "#{key}_value".to_sym
+        define_method(method_name) { _components[key].value_for(self) }
+        memoize method_name
+        alias_method key, method_name unless method_defined?(key)
+      end
+
+      def define_component_predicate(key)
+        method_name = "#{key}_value?".to_sym
+        define_method(method_name) { public_send("#{key}_value".to_sym).present? }
+        alias_method "#{key}?".to_sym, method_name
+      end
+    end
+
+    class Component
+      attr_reader :options
+
+      def initialize(**options, &block)
+        @options = {}
+        configure(**options, &block)
+      end
+
+      def value_for(object)
+        object.instance_eval(&@value).dup if @value.respond_to?(:call)
+      end
+
+      def configure(**opts, &block)
+        @value = block if block_given?
+        options.merge!(**opts)
+      end
+
+      def initialize_copy(other)
+        super
+        @options = @options.dup
+        @value = @value.dup if @value.present?
+      end
+    end
+  end
+end

data/lib/material/concerns/core.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Material is a component framework for defining the presentation layer of an application
+module Material
+  module Core
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :source
+
+      delegate :name, to: :class, prefix: true
+
+      delegate_missing_to :source
+    end
+
+    class_methods do
+      private
+
+      def references(field, as:, from: :source)
+        delegate field, to: from
+        alias_method as, field
+      end
+    end
+
+    def initialize(object)
+      raise ArgumentError, "source is required" if object.nil?
+
+      @source = object
+    end
+  end
+end

data/lib/material/concerns/for.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Build materials from objects based either an explicit definition or an optimistic lookup
+module Material
+  module For
+    extend ActiveSupport::Concern
+
+    LOOKUP_NAME = :material_class
+
+    class_methods do
+      def material_class_for(object, subtype)
+        object.try(LOOKUP_NAME) || object.class.try(LOOKUP_NAME) || "#{object.class.name}#{subtype}".safe_constantize
+      end
+    end
+  end
+end

data/lib/material/concerns/icon.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Material
+  module Icon
+    extend ActiveSupport::Concern
+
+    included do
+      register_component :icon
+      register_component :icon_title
+    end
+  end
+end

data/lib/material/concerns/page.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Material
+  module Page
+    extend ActiveSupport::Concern
+
+    included do
+      register_component :parent
+      register_component :filter
+      register_component :filter_default
+    end
+  end
+end

data/lib/material/concerns/text.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Material
+  module Text
+    extend ActiveSupport::Concern
+
+    DEFAULT_TRUNCATE_LENGTH = 50
+
+    class_methods do
+      private
+
+      def register_title_truncator(key)
+        register_truncator(key) { title }
+      end
+
+      def register_truncator(key, max_length = DEFAULT_TRUNCATE_LENGTH, &block)
+        register_component(key, max_length: max_length, &block)
+        define_truncation_formatter(key)
+        define_truncation_predicate(key)
+      end
+
+      def define_truncation_formatter(key)
+        define_method(key) do
+          public_send("#{key}_value".to_sym).truncate(public_send("#{key}_component".to_sym).options[:max_length])
+        end
+        memoize key
+      end
+
+      def define_truncation_predicate(key)
+        method_name = "#{key}_truncated?".to_sym
+        define_method(method_name) do
+          public_send("#{key}_value".to_sym).length > public_send("#{key}_component".to_sym).options[:max_length]
+        end
+        memoize method_name
+      end
+    end
+
+    included do
+      register_truncator(:title) { default_title }
+
+      register_component(:parameterized_title) { title_value.underscore.parameterize }
+
+      register_title_truncator :list_title
+      register_title_truncator :header_title
+      register_title_truncator :reference_title
+      register_title_truncator :breadcrumb_title
+
+      private
+
+      def default_title
+        source.try(:name) || self.class.try(:model_name)&.human || self.class.name
+      end
+    end
+  end
+end

data/lib/material/list.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "concerns/components"
+require_relative "concerns/icon"
+require_relative "concerns/text"
+
+module Material
+  class List < Collectible::CollectionBase
+    include Material::Components
+    include Material::Icon
+    include Material::Text
+    include Material::Page
+    include Material::For
+
+    def self.for(object)
+      material_class_for(object, "List")
+    end
+
+    def default_title
+      (item_class.try(:model_name)&.human || item_class&.name).pluralize || self.class.name
+    end
+  end
+end

data/lib/material/rspec/custom_matchers/have_material_component.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usages of `.register_component`
+#
+#     class ExampleMaterial < ApplicationMaterial
+#       register_component :foo
+#       register_component :bar, max_length: 10
+#     end
+#
+#     RSpec.describe ExampleMaterial do
+#       it { is_expected.to have_material_component :foo }
+#       it { is_expected.to have_material_component(:bar).with_options(max_length: 10) }
+#     end
+
+RSpec::Matchers.define :have_material_component do |component_name|
+  match do
+    @component = test_subject._components[component_name]
+
+    @component.present? && @component.instance_of?(Material::Components::Component) && options_matching?
+  end
+
+  def options_matching?
+    if @options.present?
+      @options.keys.all? { |option| @component.options[option] == @options[option] }
+    else
+      true
+    end
+  end
+
+  chain :with_options do |options|
+    @options = options
+  end
+
+  description do
+    "have material component #{component_name}#{" with options #{@options}" if @options.present?}"
+  end
+
+  failure_message do
+    "expected to have material component #{component_name}#{" with options #{@options}" if @options.present?}"
+  end
+
+  failure_message_when_negated do
+    "not expected to have material component #{component_name}#{" with options #{@options}" if @options.present?}"
+  end
+
+  def test_subject
+    subject.is_a?(Class) ? subject : subject.class
+  end
+end

data/lib/material/rspec/custom_matchers.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "custom_matchers/have_material_component"

data/lib/material/spec_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "rspec/custom_matchers"

data/lib/material/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Material
+  VERSION = "0.2.3"
+end

data/lib/material.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "active_support"
+
+require "spicerack"
+
+require_relative "material/concerns/components"
+require_relative "material/concerns/core"
+require_relative "material/concerns/icon"
+require_relative "material/concerns/text"
+require_relative "material/concerns/page"
+require_relative "material/concerns/for"
+
+require "material/version"
+
+require "material/base"
+require "material/list"
+
+module Material; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: material
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Eric Garside
@@ -203,7 +203,22 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/material.rb
+- lib/material/base.rb
+- lib/material/concerns/components.rb
+- lib/material/concerns/core.rb
+- lib/material/concerns/for.rb
+- lib/material/concerns/icon.rb
+- lib/material/concerns/page.rb
+- lib/material/concerns/text.rb
+- lib/material/list.rb
+- lib/material/rspec/custom_matchers.rb
+- lib/material/rspec/custom_matchers/have_material_component.rb
+- lib/material/spec_helper.rb
+- lib/material/version.rb
 homepage: https://github.com/Freshly/material
 licenses:
 - MIT