compex 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a05ce5e69574029faf2e79599fa9da036407cc795dbdbb0cdf1b61bee7207fa9
+  data.tar.gz: 2aafbe674927a37b3be6765eadb1728e034f0ccc5eb320c46c81cf67291d9e78
+SHA512:
+  metadata.gz: c0b66d2086af516eff2747260fcde3d41442b9efac231b2f91d841f46e1022a1307ca0c3263a5eed4eba6ac94397cbaf73b404caeb346afd301ec2aa6d375321
+  data.tar.gz: ac8a634d182846d66e175a6fe99fced4ee9f9d0caf8500fe0ae0e6b077175690cff1cc5e6d9b97346d368b779db6a172176ad825ba0c7f7a98a7de051f4a898b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,69 @@
+plugins: rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 3.4
+  NewCops: enable
+  Exclude:
+    - vendor/**/*
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceAroundOperators:
+  EnforcedStyleForExponentOperator: space
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Lint/UselessAssignment:
+  Exclude:
+    - spec/**/*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/README.md

@@ -0,0 +1,43 @@
+# CompEx
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/CompEx`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## 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 the created tag, 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/[USERNAME]/CompEx. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/CompEx/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CompEx project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/CompEx/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/compex/asset_provider.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CompEx
+  class AssetProvider
+    def self.provide(hashed)
+      return nil if !hashed.is_a?(String) || hashed.length < 2
+
+      case hashed[0]
+      when "j"
+        script = Cache.get_hashed_script(hashed[2...])
+        return nil unless script
+
+        script[1]
+      when "c"
+        style = Cache.get_hashed_style(hashed[2...])
+        return nil unless style
+
+        style[1]
+      end
+    end
+  end
+end

data/lib/compex/bag.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CompEx
+  class Bag
+    def initialize(parent, **args)
+      parent.defined_args.each do |arg|
+        next unless args.key? arg
+
+        define_singleton_method(arg) { args[arg] }
+      end
+      @_extra_css_hashes = []
+      @_extra_js_hashes = []
+    end
+
+    def extra_css_hashes = @_extra_css_hashes
+    def extra_js_hashes = @_extra_js_hashes
+
+    def render(klass, **args)
+      inst = klass.new(**args)
+      @_extra_css_hashes << inst.css_hash
+      @_extra_js_hashes << inst.js_hash
+      inst.render_html
+    end
+  end
+end

data/lib/compex/base.rb

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+
+module CompEx
+  class Base
+    class << self
+      def args(first, *rest)
+        [first, *rest].each { arg(it) }
+        self
+      end
+
+      def arg(first, *rest)
+        var_name = "@#{first}"
+        name = first
+        define_method(name) { instance_variable_get(var_name).to_s }
+        define_method("#{name}=") do |value|
+          instance_variable_set(var_name, UnsafeString.new(value))
+        end
+        @args ||= []
+        @args << name
+
+        return self if rest.empty?
+
+        warn "CompEx: #{self.name}: arg #{[first, *rest].join(", ")} should be args #{[first, *rest].join(", ")}"
+        rest.each { arg(it) }
+        self
+      end
+
+      def expose(first, *rest)
+        @exposed ||= []
+        @exposed << first
+        @exposed.append(*rest)
+        @exposed.uniq!
+        nil
+      end
+
+      def html(source)
+        @html = source
+        self
+      end
+
+      def style(source)
+        @style = source
+        self
+      end
+
+      def js(source)
+        @js = source
+        self
+      end
+
+      def raw_component_id
+        @raw_component_id ||= name || hash.to_s(36)
+      end
+
+      def component_id
+        @component_id ||= hash_string(raw_component_id)
+      end
+
+      def js_class_id
+        return @js_class_id if @js_class_id
+
+        class_id = name.split("::").map do |id|
+          next id unless id.start_with? "#"
+
+          hash_string(id)
+        end.join
+        @js_class_id ||= ["CompEx_", class_id, "_", component_id.upcase].join
+      end
+
+      def hash_string(str)
+        value = 2906
+        str.chars.map(&:ord).each do |v|
+          value = (value * 33) ^ v
+        end
+
+        (value & 0xFFFFFFFF).to_s(36)
+      end
+
+      def inherited(subclass)
+        super
+        CompEx::ComponentRegistry.register(subclass)
+      end
+
+      def stable_class_id(klass)
+        klass.name || Digest::SHA256.hexdigest(klass.inspect)
+      end
+
+      def defined_args
+        @args || []
+      end
+    end
+
+    using CompEx::StringRefinements
+
+    def html
+      @html ||= Cache.html(self.class) do
+        Template.parse(self.class.instance_variable_get(:@html) || find_template, self.class)
+      end
+    end
+
+    def style
+      self.class.instance_variable_get(:@style) || find_style
+    end
+
+    attr_reader :css, :css_hash, :js_hash, :js
+
+    def initialize(**args)
+      @bag = Bag.new(self, **args)
+      @extra_hashes = []
+
+      initialize_css
+      initialize_js
+    end
+
+    def exposed = self.class.instance_variable_get(:@exposed) || []
+
+    def initialize_css
+      css_id, css_source, css_hash = Cache.style(self.class) do
+        id, css = Style.compile(self, html.root_classes)
+        # Keeping define_css_prefix here, so we only define it once.
+        html.define_css_prefix(id)
+        css_hash = Digest::SHA1.hexdigest(css)
+        [id, css, "c_#{css_hash}"]
+      end
+      @css_id = css_id
+      @css = css_source
+      @css_hash = css_hash
+    end
+
+    def initialize_js
+      js = self.class.instance_variable_get(:@js) || find_js
+      return unless js
+
+      hash, src = Cache.script(self.class) do
+        js_hash = Digest::SHA1.hexdigest(js)
+        # Keeping define_js_module here, so we only define it once.
+        html.define_js_module(self.class.js_class_id)
+        ["j_#{js_hash}", JSRewriter.rewrite(self.class, js)]
+      end
+      @js = src
+      @js_hash = hash
+    end
+
+    def defined_args = self.class.defined_args
+
+    def render_html
+      html.render do |v|
+        case v
+        when Hash
+          inst = v[:component].new(**v[:args])
+          ret = inst.render_html do
+            v[:children]
+          end
+          @extra_hashes << inst.required_hashes
+          ret
+
+        when Proc
+          @bag.instance_exec(&v)
+        else
+          raise "Unexpected value of type #{v.class} provided by Renderer#render"
+        end
+      end
+    end
+
+    def required_hashes
+      [@css_hash, @js_hash, @bag.extra_css_hashes, @bag.extra_js_hashes, @extra_hashes]
+        .flatten
+        .compact
+        .uniq
+    end
+
+    def component_name
+      return nil if self.class.name.nil?
+
+      @component_name ||= self.class.name.split("::").map do |item|
+        next item if item[0] == "#"
+
+        item.underscore
+      end.join("/")
+    end
+
+    private
+
+    def find_template
+      path = CompEx.config.lookup_template(self, :html)
+      begin
+        File.read(path)
+      rescue Errno::ENOENT
+        raise "No template defined by #{self.class.name} (through ::html), nor could be found at #{path}"
+      end
+    end
+
+    def find_style
+      cname = component_name
+      return nil unless cname
+
+      path = CompEx.config.lookup_template(self, :style)
+      begin
+        style = File.read(path)
+      rescue Errno::ENOENT
+        return nil
+      end
+
+      Style.compile(style)
+    end
+
+    def find_js
+      cname = component_name
+      return nil unless cname
+
+      path = CompEx.config.lookup_template(self, :js)
+      begin
+        File.read(path)
+      rescue Errno::ENOENT
+        nil
+      end
+    end
+  end
+end

data/lib/compex/cache/base.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CompEx
+  class Cache
+    class Base
+      def prepare!(*, **) = nil
+      def prefix(key) = "#{CompEx.config.cache_prefix}#{key}"
+    end
+  end
+end

data/lib/compex/cache/memcached_backend.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CompEx
+  class Cache
+    class MemcachedBackend
+      def prepare!(*, **)
+        begin
+          require "memcached"
+        rescue LoadError
+          raise "CompEx: Memcached cache mode requires the gem 'memcached' to be installed."
+        end
+        @instance = Memcached::Client.new(*, **)
+      end
+
+      def set(key, value) = @instance.set(prefix(key), value)
+      def get(key) = @instance.get(prefix(key))
+    end
+  end
+end

data/lib/compex/cache/memory_backend.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CompEx
+  class Cache
+    class MemoryBackend < Base
+      def prepare!(*, **)
+        @keys = {}
+      end
+
+      def set(key, value)
+        @keys[prefix(key)] = value
+      end
+
+      def get(key) = @keys[prefix(key)]
+    end
+  end
+end

data/lib/compex/cache/noop_backend.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CompEx
+  class Cache
+    class NoopBackend < Base
+      def get(*) = nil
+      def set(*) = nil
+    end
+  end
+end

data/lib/compex/cache/redis_backend.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CompEx
+  class Cache
+    class RedisBackend < Base
+      def prepare!(*, **)
+        begin
+          require "redis"
+        rescue LoadError
+          raise "CompEx: Redis cache mode requires the gem 'redis' to be installed."
+        end
+        @instance = Redis.new(*, **)
+      end
+
+      def set(key, value) = @instance.set(prefix(key), value)
+      def get(key) = @instance.get(prefix(key))
+    end
+  end
+end

data/lib/compex/cache.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "cache/base"
+require_relative "cache/memcached_backend"
+require_relative "cache/memory_backend"
+require_relative "cache/noop_backend"
+require_relative "cache/redis_backend"
+
+module CompEx
+  class Cache
+    class << self
+      def backend = CompEx.config.cache_backend
+      def stable_class_id(comp) = CompEx::Base.stable_class_id(comp)
+
+      def style(component_class)
+        stable_id = stable_class_id(component_class)
+        stable_key = "style:#{stable_id}"
+        v = backend.get(stable_key)
+        return JSON.parse(v, symbolize_names: true) if v
+
+        r = yield
+        backend.set("style:#{r.last[2...]}", stable_id)
+        backend.set(stable_key, r.to_json)
+
+        r
+      end
+
+      def get_hashed_style(hashed)
+        ptr = backend.get("style:#{hashed}")
+        return nil unless ptr
+
+        v = backend.get("style:#{ptr}")
+        return nil unless v
+
+        JSON.parse(v, symbolize_names: true)
+      end
+
+      def html(component_class)
+        stable_id = stable_class_id(component_class)
+        stable_key = "html:#{stable_id}"
+        v = backend.get(stable_key)
+        return v if v
+
+        html = yield
+        backend.set(stable_key, html)
+
+        html
+      end
+
+      def script(component_class)
+        stable_id = stable_class_id(component_class)
+        stable_key = "script:#{stable_id}"
+        v = backend.get(stable_key)
+        return JSON.parse(v, symbolize_names: true) if v
+
+        r = yield
+        backend.set(stable_key, r.to_json)
+        backend.set("script:#{r.first[2...]}", stable_id)
+
+        r
+      end
+
+      def get_hashed_script(hashed)
+        ptr = backend.get("script:#{hashed}")
+        return nil unless ptr
+
+        v = backend.get("script:#{ptr}")
+        return nil unless v
+
+        JSON.parse(v, symbolize_names: true)
+      end
+    end
+  end
+end