amber_component 0.0.2 → 0.0.3

data/docs/_config.yml

@@ -0,0 +1,148 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole site, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing these this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'jekyll serve'. If you change this file, please restart the server process.
+
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+title: Amber Component
+baseurl: '/amber-doc-test' # the subpath of your site, e.g. /blog
+# url: https://ambercomponent.com # the base hostname & protocol for your site, e.g. http://example.com
+url: https://garbusbeach.com/ # the base hostname & protocol for your site, e.g. http://example.com
+
+theme: just-the-docs
+# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
+# color_scheme: "dark"
+color_scheme: "amber_component"
+
+permalink: pretty
+exclude: [
+  "node_modules/",
+  "*.gemspec",
+  "*.gem",
+  "Gemfile",
+  "Gemfile.lock",
+  "package.json",
+  "package-lock.json",
+  "script/",
+  "LICENSE.txt",
+  "lib/",
+  "bin/",
+  "README.md",
+  "Rakefile" ,
+  "docs/tests/"
+]
+
+# Regression tests
+# By default, the pages in /docs/tests are excluded when the ste is built.
+# To include them, comment-out the relevant line above.
+# Uncommenting the following line doesn't work - see https://github.com/jekyll/jekyll/issues/4791
+# include: ["docs/tests/"]
+
+# Set a path/url to a logo that will be displayed instead of the title
+logo: /assets/images/logo_wide.png
+
+# Enable or disable the site search
+# Supports true (default) or false
+search_enabled: true
+search:
+  # Split pages into sections that can be searched individually
+  # Supports 1 - 6, default: 2
+  heading_level: 2
+  # Maximum amount of previews per search result
+  # Default: 3
+  previews: 2
+  # Maximum amount of words to display before a matched word in the preview
+  # Default: 5
+  preview_words_before: 3
+  # Maximum amount of words to display after a matched word in the preview
+  # Default: 10
+  preview_words_after: 3
+  # Set the search token separator
+  # Default: /[\s\-/]+/
+  # Example: enable support for hyphenated search words
+  tokenizer_separator: /[\s/]+/
+  # Display the relative url in search results
+  # Supports true (default) or false
+  rel_url: true
+  # Enable or disable the search button that appears in the bottom right corner of every page
+  # Supports true or false (default)
+  button: false
+
+# Enable or disable heading anchors
+heading_anchors: true
+
+# Aux links for the upper right navigation
+aux_links:
+  AmberComponent on GitHub:
+    - https://github.com/amber-ruby/amber_component
+
+# Makes Aux links open in a new tab. Default is false
+aux_links_new_tab: true
+
+# Sort order for navigation links
+# nav_sort: case_insensitive # default, equivalent to nil
+nav_sort: case_sensitive # Capital letters sorted before lowercase
+
+# Footer content
+# appears at the bottom of every page's main content
+
+# Back to top link
+back_to_top: true
+back_to_top_text: "Back to top"
+
+footer_content: >-
+  Copyright ©
+  <script type="text/javascript">
+    document.write(new Date().getFullYear());
+  </script>
+  <a class="personal-link" href="{{ site.data.amber_component.garbus_beach_url }}">Garbus Beach</a>,
+  <a class="personal-link" href="{{ site.data.amber_component.mateusz_drewniak_url }}">Mateusz Drewniak</a>.
+  Made with ❤️ for ruby.
+
+# Footer last edited timestamp
+last_edit_timestamp: false # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
+last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
+
+
+
+# Footer "Edit this page on GitHub" link text
+gh_edit_link: false # show or hide edit this page link
+# gh_edit_link_text: "Edit this page on GitHub"
+# gh_edit_repository: "https://github.com/just-the-docs/just-the-docs" # the github URL for your repo
+# gh_edit_branch: "main" # the branch that your docs is served from
+# gh_edit_source: docs # the source that your files originate from
+# gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
+
+# Google Analytics Tracking (optional)
+# e.g, UA-1234567-89
+
+# TODO:
+# ga_tracking: UA-2709176-10
+# ga_tracking_anonymize_ip: false # Use GDPR compliant Google Analytics settings (true/nil by default)
+
+plugins:
+  - jekyll-seo-tag
+
+kramdown:
+  syntax_highlighter_opts:
+    block:
+      line_numbers: false
+
+compress_html:
+  clippings: all
+  comments: all
+  endings: all
+  startings: []
+  blanklines: false
+  profile: false
+  # ignore:
+  #   envs: all

data/docs/_data/amber_component.yml

@@ -0,0 +1,3 @@
+version: 1.0.0
+garbus_beach_url: https://garbusbeach.com
+mateusz_drewniak_url: https://mateuszdrewniak.it

data/docs/_sass/_variables.scss

@@ -0,0 +1,2 @@
+$amber_color: #FF9500;
+$amber_black: #402E32;

data/docs/_sass/color_schemes/amber_component.scss

@@ -0,0 +1,11 @@
+@import url(https://cdn.jsdelivr.net/npm/firacode@6.2.0/distr/fira_code.css);
+
+@import './color_schemes/dark.scss';
+@import './../variables.scss';
+
+$link-color: $amber_color;
+$btn-primary-color: $amber_color;
+$body-font-family: 'Fira Code', Menlo, Consolas, Monospace;
+$mono-font-family: $body-font-family;
+// $body-background-color: $amber_black;
+// $sidebar-color: $amber_black;

data/docs/_sass/custom/custom.scss

@@ -0,0 +1,60 @@
+@import './../variables.scss';
+
+.site-footer {
+  display: none;
+}
+
+.search {
+  input.search-input {
+    color: white;
+  }
+}
+
+.btn {
+  &:focus,
+  &:focus:hover,
+  &.selected:focus {
+    box-shadow: 0 0 0 3px rgba($amber_color, 0.25);
+  }
+}
+
+footer {
+  a.personal-link {
+    color: #5c5962;
+    text-decoration: underline;
+
+    &:hover {
+      color: $amber_color;
+    }
+  }
+}
+
+.site-header {
+  a.site-title {
+    &:hover {
+      background-image: none;
+    }
+  }
+}
+
+.nav-list {
+  .nav-list-item {
+    a.nav-list-link {
+      color: rgba(255, 255, 255, 0.8);
+    }
+
+    &.active {
+      // margin: 0 16px;
+      border-radius: 2px;
+      background-color: rgba($amber_color, 0.3);
+
+      a.nav-list-link {
+        &.active {
+          // padding-left: 18px;
+          color: $amber_color;
+          background-image: none;
+        }
+      }
+    }
+  }
+}

data/docs/api/index.md

@@ -0,0 +1,8 @@
+---
+layout: default
+title: API
+nav_order: 5
+has_children: true
+---
+
+# Api

data/docs/changelog/index.md

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Changelog
+nav_order: 6
+has_children: false
+---
+
+# Changelog

data/docs/getting_started/index.md

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Getting started
+nav_order: 3
+has_children: true
+---
+
+# Getting started

data/docs/getting_started/installation.md

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Installation
+parent: Getting started
+---
+
+# Installation

data/docs/getting_started/ruby_support.md

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Ruby support
+parent: Getting started
+---
+
+# Ruby support

data/docs/getting_started/wireframes.md

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Wireframes
+parent: Getting started
+---
+
+# Wireframes

data/docs/index.md

@@ -0,0 +1,17 @@
+---
+layout: default
+title: Home
+nav_order: 1
+permalink: /
+---
+
+# AmberComponent (v{{ site.data.amber_component.version }})
+
+A simple component library which seamlessly hooks into your Rails project and allows you to create simple backend components. They work like mini controllers which are bound with their view.
+
+Created by [Garbus Beach]({{ site.data.amber_component.garbus_beach_url }}){:target="_blank"}
+and
+[Mateusz Drewniak]({{ site.data.amber_component.mateusz_drewniak_url }}){:target="_blank"}.
+
+[Get started now](#getting-started){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }
+[View it on GitHub](https://github.com/amber-ruby/amber_component){: .btn .fs-5 .mb-4 .mb-md-0 target="_blank"}

data/docs/introduction/basic_usage.md

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Basic usage
+parent: Introduction
+---
+
+# Basic usage

data/docs/introduction/index.md

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Introduction
+nav_order: 2
+has_children: true
+---
+
+# Introduction

data/docs/introduction/why_amber_component.md

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Why AmberComponent?
+parent: Introduction
+---
+
+# Why AmberComponent?

data/docs/resources/index.md

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Resources
+nav_order: 7
+has_children: true
+---
+
+# Resources

data/docs/styles/index.md

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Styles
+nav_order: 5
+has_children: true
+---
+
+# Styles

data/docs/styles/usage.md

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Usage
+parent: Styles
+---
+
+# Usage

data/docs/views/index.md

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Views
+nav_order: 4
+has_children: true
+---
+
+# Views

data/docs/views/usage.md

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Usage
+parent: Views
+---
+
+# Usage

data/lib/amber_component/assets.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module ::AmberComponent
+  # Provides methods for locating and manipulating component assets.
+  module Assets
+    # Class methods for assets.
+    module ClassMethods
+      # @return [String]
+      def asset_dir_path
+        component_file_path, = source_location
+        return asset_dir_from_name unless component_file_path
+
+        component_file_path.delete_suffix('.rb')
+      end
+
+      # @return [String, nil]
+      def asset_dir_from_name
+        return unless defined?(::Rails)
+
+        ::Rails.root / 'app' / 'components' / name.underscore
+      end
+
+      # Get an array of all folders containing component assets.
+      # This method should only be used on the parent class `AmberComponent::Base` or `ApplicationComponent`.
+      #
+      # @return [Array<String>]
+      def all_asset_dir_paths
+        subclasses.map(&:asset_dir_path)
+      end
+
+      # @param file_name [String, nil]
+      # @return [String, nil]
+      def asset_path(file_name)
+        return unless file_name
+
+        ::File.join(asset_dir_path, file_name)
+      end
+
+      # Returns the name of the file inside the asset directory
+      # of this component that matches the provided `Regexp`
+      #
+      # @param type_regexp [Regexp]
+      # @return [Array<String>]
+      def asset_file_names(type_regexp)
+        return [] unless ::File.directory?(asset_dir_path)
+
+        ::Dir.entries(asset_dir_path).select do |file|
+          next unless ::File.file?(::File.join(asset_dir_path, file))
+
+          file.match? type_regexp
+        end
+      end
+    end
+
+    # Instance methods for assets.
+    module InstanceMethods
+    end
+  end
+end