vident 0.7.0 → 0.8.0

data/CHANGELOG.md

@@ -1,79 +0,0 @@
-
-# Change Log
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).
-
-## [Unreleased]
-
-### Added
-
-### Changed
-
-### Fixed
-
-## [0.7.0] - 2023-03-08  
-
-### Added
-
-- new `Vident::Tailwind` module which uses [tailwind_merge](https://github.com/gjtorikian/tailwind_merge) to merge TailwindCSS classes
-
-### Changed
-
-- Removed a dependency on intenal constants from `phlex`
-
-## [0.6.3] - 2023-03-03
-
-### Fixed
-
-- Fix for changes to HTML tag collection in Phlex
-
-
-## [0.6.2] - 2023-02-23
-
-### Fixed
-
-- Element tag options are not set when no ID is provided
-
-
-## [0.6.1] - 2023-02-20
-
-### Fixed
-
-- `better_html` support fix for aliased dsl methods
-
-
-## [0.6.0] - 2023-02-20
-
-### Added
-
-- Experimental support for `better_html` in the root components (the stimulus attributes are generated with `html_attributes`)
-
-
-
-## [0.5.1] - 2023-02-17
-
-### Added
-
-- N/A
-
-### Changed
-
-- N/A
-
-### Fixed
-
-- Typed attributes was not always using custom coercion methods if they were defined 
-
-### Removed
-
-- N/A
-
-### Deprecated
-
-- N/A
-
-### Security
-
-- N/A

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at stevegeek@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in vident.gemspec
-gemspec
-
-gem "puma"
-
-gem "rails", ">= 7"
-# TODO: move examples to another app?
-gem "sprockets-rails"
-gem "tailwindcss-rails"
-gem "turbo-rails"
-gem "importmap-rails"
-gem "stimulus-rails"
-
-gem "dry-struct"
-
-gem "phlex-rails"
-gem "better_html"
-gem "tailwind_merge"
-
-# FIXME: versions greater than 2.74 cause issues: https://github.com/ViewComponent/view_component/pull/1571
-gem "view_component", "2.74.1"
-
-gem "sqlite3"
-
-gem "rake", "~> 13.0"
-
-gem "minitest", "~> 5.0"
-gem "minitest-hooks"
-gem "faker"
-
-gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2022 Stephen Ierodiaconou
-
-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/lib/tasks/vident.rake

@@ -1,37 +0,0 @@
-require "stimulus/manifest"
-
-namespace :vident do
-  task :stimulus_controller_imports do
-    paths = {
-      "app/components" => "../../../app/components",
-      "app/views" => "../../../app/views",
-      "app/javascript/controllers" => "."
-    }
-    manifests = []
-    paths.each do |controllers_path, import_path|
-      vc_controllers_path = Rails.root.join(controllers_path)
-      manifests << Stimulus::Manifest.extract_controllers_from(vc_controllers_path).collect do |controller_path|
-        controller_path = controller_path.relative_path_from(vc_controllers_path).to_s
-        module_path = controller_path.split(".").first
-        controller_class_name = module_path.camelize.gsub(/::/, "__")
-        tag_name = module_path.remove(/_controller/).tr("_", "-").gsub(/\//, "--")
-
-        <<~JS
-          import #{controller_class_name} from "#{import_path}/#{controller_path.gsub(".ts", "")}"
-          application.register("#{tag_name}", #{controller_class_name});
-        JS
-      end
-    end
-
-    File.open(Rails.root.join("app/javascript/controllers/index.js"), "w+") do |index|
-      index.puts "// This file is auto-generated by ./bin/rails stimulus_controller_imports"
-      index.puts "// Run that command whenever you add a new controller or create them with"
-      index.puts "// ./bin/rails generate stimulus controllerName"
-      index.puts
-      index.puts %(import { application } from "./application")
-      manifests.each do |manifest|
-        index.puts manifest
-      end
-    end
-  end
-end

data/lib/vident/attributes/typed.rb

@@ -1,229 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/concern"
-
-if Gem.loaded_specs.has_key? "dry-struct"
-  require_relative "./types"
-  require_relative "./typed_niling_struct"
-
-  module Vident
-    # Adapts Dry Types to confinus Typed Attributes. We use dry-struct (see TypedNilingStruct) but
-    # we could probably also use dry-initializer directly, saving us from maintaining the schema.
-    module Attributes
-      module Typed
-        extend ActiveSupport::Concern
-
-        # TODO: better handling of when either class.schema is undefined (as no attributes configured) or when
-        # other methods ar called before prepare_attributes is called
-        def prepare_attributes(attributes)
-          @__attributes = self.class.schema.new(**attributes)
-        end
-
-        def attributes
-          @__attributes.attributes
-        end
-
-        def attribute_names
-          @attribute_names ||= self.class.attribute_names
-        end
-
-        def attribute(key)
-          if Rails.env.development? && !key?(key)
-            raise StandardError, "Attribute #{key} not found in #{self.class.name}"
-          end
-          @__attributes.attributes[key]
-        end
-        alias_method :[], :attribute
-
-        def key?(key)
-          self.class.schema.attribute_names.include?(key)
-        end
-
-        def to_hash
-          @__attributes.to_h
-        end
-
-        class_methods do
-          def inherited(subclass)
-            subclass.instance_variable_set(:@schema, @schema.clone)
-            subclass.instance_variable_set(:@attribute_ivar_names, @attribute_ivar_names.clone)
-            super
-          end
-
-          def attribute_names
-            schema.attribute_names
-          end
-
-          def attribute_metadata(key)
-            schema.schema.key(key).meta
-          end
-
-          attr_reader :schema, :attribute_ivar_names
-
-          def attribute(name, signature = :any, **options, &converter)
-            strict = !options[:convert]
-            signatures = extract_member_type_and_subclass(signature, options)
-            type_info = map_primitive_to_dry_type(signatures, strict, converter)
-            type_info = set_constraints(type_info, options)
-            type_info = set_metadata(type_info, signatures, options)
-            define_on_schema(name, type_info, options)
-          end
-
-          private
-
-          def set_constraints(type_info, options)
-            if allows_nil?(options)
-              type_info = type_info.optional.meta(required: false)
-            end
-            unless allows_blank?(options)
-              type_info = type_info.constrained(filled: true)
-            end
-            if options[:default]&.is_a?(Proc)
-              type_info = type_info.default(options[:default].freeze)
-            elsif !options[:default].nil?
-              type_info = type_info.default(->(_) { options[:default] }.freeze)
-            end
-            if options[:in]
-              type_info.constrained(included_in: options[:in].freeze)
-            end
-            type_info
-          end
-
-          def set_metadata(type_info, signatures, options)
-            metadata = {typed_attribute_type: signatures, typed_attribute_options: options}
-            type_info.meta(**metadata)
-          end
-
-          def delegates?(options)
-            options[:delegates] != false
-          end
-
-          def define_on_schema(attribute_name, type_info, options)
-            @attribute_ivar_names ||= {}
-            @attribute_ivar_names[attribute_name] = :"@#{attribute_name}"
-            define_attribute_delegate(attribute_name) if delegates?(options)
-            @schema ||= const_set(:TypedSchema, Class.new(Vident::Attributes::TypedNilingStruct))
-            @schema.attribute attribute_name, type_info
-          end
-
-          def define_attribute_delegate(attr_name)
-            # Define reader & presence check method
-            class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-          def #{attr_name}
-            @__attributes.attributes[:#{attr_name}]
-          end
-
-          def #{attr_name}?
-            send(:#{attr_name}).present?
-          end
-            RUBY
-          end
-
-          def allows_nil?(options)
-            return true unless options
-            allow_nil = options[:allow_nil]
-            return false if allow_nil == false
-            allow_nil || allows_blank?(options)
-          end
-
-          def allows_blank?(options)
-            return true unless options
-            allow_blank = options[:allow_blank]
-            allow_blank.nil? ? true : allow_blank
-          end
-
-          def map_primitive_to_dry_type(signatures, strict, converter)
-            types = signatures.map do |type, subtype|
-              dry_type = dry_type_from_primary_type(type, strict, converter)
-              if subtype && dry_type.respond_to?(:of)
-                subtype_info = dry_type_from_primary_type(subtype, strict, converter)
-                # Sub types of collections currently can be nil - this should be an option
-                dry_type.of(subtype_info.optional.meta(required: false))
-              else
-                dry_type
-              end
-            end
-            types.reduce(:|)
-          end
-
-          def extract_member_type_and_subclass(signature, options)
-            case signature
-            when Set
-              signature.flat_map { |s| extract_member_type_and_subclass(s, options) }
-            when Array
-              [[Array, signature.first]]
-            else
-              [[signature, options[:type] || options[:sub_type]]]
-            end
-          end
-
-          def dry_type_from_primary_type(type, strict, converter)
-            # If a converter is provided, we should use it to coerce the value
-            if converter && !strict && !type.is_a?(Symbol)
-              return Types.Constructor(type) do |value|
-                next value if value.is_a?(type)
-
-                converter.call(value).tap do |new_value|
-                  unless new_value.is_a?(type)
-                    raise ArgumentError, "Type conversion proc did not convert #{value} to #{type}"
-                  end
-                end
-              end
-            end
-
-            if type == :any
-              Types::Nominal::Any
-            elsif type == Integer
-              strict ? Types::Strict::Integer : Types::Params::Integer
-            elsif type == BigDecimal
-              strict ? Types::Strict::Decimal : Types::Params::Decimal
-            elsif type == Float
-              strict ? Types::Strict::Float : Types::Params::Float
-            elsif type == Numeric
-              if strict
-                Types::Strict::Float | Types::Strict::Integer | Types::Strict::Decimal
-              else
-                Types::Params::Float | Types::Params::Integer | Types::Params::Decimal
-              end
-            elsif type == Symbol
-              strict ? Types::Strict::Symbol : Types::Coercible::Symbol
-            elsif type == String
-              strict ? Types::Strict::String : Types::Coercible::String
-            elsif type == Time
-              strict ? Types::Strict::Time : Types::Params::Time
-            elsif type == Date
-              strict ? Types::Strict::Date : Types::Params::Date
-            elsif type == Array
-              strict ? Types::Strict::Array : Types::Params::Array
-            elsif type == Hash
-              strict ? Types::Strict::Hash : Types::Coercible::Hash
-            elsif type == :boolean
-              strict ? Types::Strict::Bool : Types::Params::Bool
-            elsif strict
-              # when strict create a Nominal type with a is_a? constraint, otherwise create a Nominal type which constructs
-              # values using the default constructor, `new`.
-              Types.Instance(type)
-            else
-              # dry calls this when initialising the Type. Check if type of input is correct or create new instance
-              Types.Constructor(type) do |value|
-                next value if value.is_a?(type)
-
-                type.new(**value)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-else
-  module Vident
-    module Attributes
-      module Typed
-        def self.included(base)
-          raise "Vident::Attributes::Typed requires dry-struct to be installed"
-        end
-      end
-    end
-  end
-end

data/lib/vident/attributes/typed_niling_struct.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Vident
-  module Attributes
-    # A dry struct that is loose about keys provided on initialization. It sets them to nil if not provided.
-    # It is strict about types but not about provided keys
-    class TypedNilingStruct < ::Dry::Struct
-      # convert string keys to symbols
-      transform_keys(&:to_sym)
-
-      # resolve default types on nil
-      transform_types do |type|
-        if type.default?
-          type.constructor { |value| value.nil? ? ::Dry::Types::Undefined : value }
-        else
-          type
-        end
-      end
-
-      class << self
-        def check_schema_duplication(new_keys)
-          # allow overriding keys
-        end
-      end
-    end
-  end
-end

data/lib/vident/attributes/types.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require "dry-struct"
-
-module Vident
-  module Attributes
-    module Types
-      include ::Dry.Types
-
-      StrippedString = Types::String.constructor(&:strip)
-      BooleanDefaultFalse = Types::Bool.default(false)
-      BooleanDefaultTrue = Types::Bool.default(true)
-      HashDefaultEmpty = Types::Hash.default({}.freeze)
-    end
-  end
-end

data/lib/vident/caching/cache_key.rb

@@ -1,144 +0,0 @@
-# frozen_string_literal: true
-
-# Rails fragment caching works by either expecting the cached key object to respond to `cache_key` or for that object
-# to be an array or hash.
-module Vident
-  module Caching
-    module CacheKey
-      extend ActiveSupport::Concern
-
-      class_methods do
-        def inherited(subclass)
-          subclass.instance_variable_set(
-            :@named_cache_key_attributes,
-            @named_cache_key_attributes.clone
-          )
-          super
-        end
-
-        def with_cache_key(*attrs, name: :_collection)
-          raise StandardError, "with_cache_key can only be used on components *without* slots as there is no eary way to track their content changes so too risky" if respond_to?(:slots?) && slots?
-          # Add view file to cache key
-          attrs << :component_modified_time
-          named_cache_key_includes(name, *attrs)
-        end
-
-        attr_reader :named_cache_key_attributes
-
-        # TypedComponents can be used with fragment caching, but you need to be careful! Read on...
-        #
-        #     <% cache component do %>
-        #      <%= render component %>
-        #    <% end %>
-        #
-        # The most important point is that Rails cannot track dependencies on the component itself, so you need to
-        # be careful to be explicit on the attributes, and manually specify any sub Viewcomponent dependencies that the
-        # component has. The assumption is that the subcomponent takes any attributes from the parent, so the cache key
-        # depends on the parent component attributes. Otherwise changes to the parent or sub component views/Ruby class
-        # will result in different cache keys too. Of course if you invalidate all cache keys with a modifier on deploy
-        # then no need to worry about changing the cache key on component changes, only on attribute/data changes.
-        #
-        # A big caveat is that the cache key cannot depend on anything related to the view_context of the component (such
-        # as `helpers` as the key is created before the rending pipline is invoked (which is when the view_context is set).
-        def depends_on(*klasses)
-          @component_dependencies ||= []
-          @component_dependencies += klasses
-        end
-
-        attr_reader :component_dependencies
-
-        def component_modified_time
-          return @component_modified_time if Rails.env.production? && @component_modified_time
-          # FIXME: This could stack overflow if there are circular dependencies
-          deps = component_dependencies&.map(&:component_modified_time)&.join("-") || ""
-          @component_modified_time = deps + sidecar_view_modified_time + rb_component_modified_time
-        end
-
-        def sidecar_view_modified_time
-          return @sidecar_view_modified_time if Rails.env.production? && defined?(@sidecar_view_modified_time)
-          @sidecar_view_modified_time = ::File.exist?(template_path) ? ::File.mtime(template_path).to_i.to_s : ""
-        end
-
-        def rb_component_modified_time
-          return @rb_component_modified_time if Rails.env.production? && defined?(@rb_component_modified_time)
-          @rb_component_modified_time = ::File.exist?(component_path) ? ::File.mtime(component_path).to_i.to_s : ""
-        end
-
-        def template_path
-          File.join components_base_path, "#{virtual_path}.html.erb"
-        end
-
-        def component_path
-          File.join components_base_path, "#{virtual_path}.rb"
-        end
-
-        def components_base_path
-          ::Rails.configuration.view_component.view_component_path || "app/components"
-        end
-
-        private
-
-        def named_cache_key_includes(name, *attrs)
-          define_cache_key_method unless @named_cache_key_attributes
-          @named_cache_key_attributes ||= {}
-          @named_cache_key_attributes[name] = attrs
-        end
-
-        def define_cache_key_method
-          # If the presenter defines cache key setup then define the method. Otherwise Rails assumes this
-          # will return a valid key if the class will respond to this
-          define_method :cache_key do |n = :_collection|
-            if defined?(@cache_key)
-              return @cache_key[n] if @cache_key.key?(n)
-            else
-              @cache_key ||= {}
-            end
-            generate_cache_key(n)
-            @cache_key[n]
-          end
-        end
-      end
-
-      # Component modified time which is combined with other cache key attributes to generate cache key for an instance
-      def component_modified_time
-        self.class.component_modified_time
-      end
-
-      def cacheable?
-        respond_to? :cache_key
-      end
-
-      def cache_key_modifier
-        ENV["RAILS_CACHE_ID"]
-      end
-
-      def cache_keys_for_sources(key_attributes)
-        sources = key_attributes.flat_map { |n| n.is_a?(Proc) ? instance_eval(&n) : send(n) }
-        sources.compact.map do |item|
-          next if item == self
-          generate_item_cache_key_from(item)
-        end
-      end
-
-      def generate_item_cache_key_from(item)
-        if item.respond_to? :cache_key_with_version
-          item.cache_key_with_version
-        elsif item.respond_to? :cache_key
-          item.cache_key
-        elsif item.is_a?(String)
-          Digest::SHA1.hexdigest(item)
-        else
-          Digest::SHA1.hexdigest(Marshal.dump(item))
-        end
-      end
-
-      def generate_cache_key(index)
-        key_attributes = self.class.named_cache_key_attributes[index]
-        return nil unless key_attributes
-        key = "#{self.class.name}/#{cache_keys_for_sources(key_attributes).join("/")}"
-        raise StandardError, "Cache key for key #{key} is blank!" if key.blank?
-        @cache_key[index] = cache_key_modifier.present? ? "#{key}/#{cache_key_modifier}" : key
-      end
-    end
-  end
-end