classic 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47ef7851e58eaa92f7c1175bb3acda23fd987a694c6583b883b3ac1d6cb9d863
+  data.tar.gz: 561ae1ed4743c29967c7c30472e5609c36b527221920ffa4d2c24dfdce57fbec
+SHA512:
+  metadata.gz: 04aec15920dcdb77462ca5c9c55bfb55136bed223b994be19cc7770c9b1ff80e8654eacc13a1acd3d1f627a3bfa263baa6c8e1733ff98aef3df06827e535b92d
+  data.tar.gz: 1d12381b0e627f796ed7d31f9421f4396096f9fe0df89a105203d8c7d46ec41ab01fd2962be172ced2a17444ac1174e8a47e674e944d802051dae8967f53ed92

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-31
+
+- Initial release

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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jiren Patel
+
+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,139 @@
+# Classic
+
+A comprehensive utility library designed to standardize and simplify the management of styles across web application and cache styles. This library facilitates consistent styling, theme management and dynamically combine components styles i.e varient,size.
+
+##  What's in it?
+
+Picture this: You're a web developer tired of juggling stylesheets like a circus performer with too many flaming torches. Well, grab your virtual wand because we're about to turn that CSS circus into a well-choreographed dance party!
+
+1. Manages all your component or html elements styles in single place.
+
+2. One change of text and POOF! Your entire app's theme changes faster than you can say "abracadabra"
+
+3. No more playing "Find and Replace" across 100 files when your client decides hot pink isn't their brand color anymore.
+
+4. Mix and match variants like you're playing dress-up with your code.
+
+5. "Small", "Large", "Primary", "Secondary" - it's like a fashion show where every component/html elements gets its moment to shine!
+
+6. Toss in a base style, add a pinch of variant magic, sprinkle some size adjustments and Your components/html elements are dressed to impress.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add classic
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install classic
+```
+
+## Usage
+
+1. Configuration.
+  - `files` is location of your styles yml.
+  - `raise_error_on_not_found`. Default value is `false`.
+    If style not found then raise an error. Disable on production environment.
+    i.e `config.raise_error_on_not_found = Rails.env.development?`
+  - `auto_reload_on_change` Rails only flag will reload styles on yaml files changes.
+    Default value is `false`. Enable in rails development env.
+    i.e `config.auto_reload_on_change = !Rails.env.development?`
+  - `classes_merge_handler` handle custom merging of classes.
+    Default is `proc { |classes| classes.join(" ") }`
+    i.e
+    ```ruby
+      tw_class_merge = TailwindMerge::Merger.new
+      proc { |classes| class_merge.merge(classes) }
+    ```
+
+  ```ruby
+
+  tw_class_merge = TailwindMerge::Merger.new
+
+  Classic.configure do |config|
+    config.files = Dir["style/**/*.yaml"]
+    config.raise_error_on_not_found = true
+    config.auto_reload_on_change = true # For rails only.
+    config.classes_merge_handler = proc { |classes| tw_class_merge.merge(classes) }
+  end
+  ```
+
+2. How to define style using yml.
+
+  ```yml
+  btn:
+    base: inline-flex items-center justify-center rounded-md text-sm font-medium transition-colors focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring disabled:pointer-events-none disabled:opacity-5
+    varient:
+      default: bg-primary text-primary-foreground shadow hover:bg-primary/90
+      destructive: bg-destructive text-destructive-foreground shadow-sm hover:bg-destructive/90
+      outline: border border-input bg-transparent shadow-sm hover:bg-accent hover:text-accent-foreground
+      secondary: bg-secondary text-secondary-foreground shadow-sm hover:bg-secondary/80
+      ghost: hover:bg-accent hover:text-accent-foreground
+      link: text-primary underline-offset-4 hover:underline
+    size:
+      default: h-9 px-4 py-2
+      sm: h-8 rounded-md px-3 text-xs
+      lg: h-10 rounded-md px-8
+      icon: h-9 w-9
+    default: "(varient.default,size.default)"
+
+  card:
+    <self: rounded-xl border bg-card text-card-foreground shadow
+    header: flex flex-col space-y-1.5 p-6
+    title: font-semibold leading-none tracking-tight
+    description: text-sm text-muted-foreground
+    content: p-6 pt-0
+    footer: flex items-center p-6 pt-0
+
+  "@aliases":
+    btn-primary: "btn(varient.outline,size.default)"
+  ```
+
+3. How to use in erb, haml templates or any other templates by calling "to_cls" method on string.
+
+  * Combine options.
+    - `btn(varient.outline,size.lg).to_cls`
+    - `btn(varient.link,size.default).to_cls`
+
+  * Default style define in  `default` key.
+    - `btn.to_cls`
+
+  * How to use alias?
+    - `btn-primary.to_cls`
+
+  * `<self` - Element has multiple sub component/element style key and want to use parent key as a container.
+    - `card.to_cls` This will use `<self` key of card.
+
+  * Add custom classes.
+    - `btn(varient.outline,size.lg).to_cls("mt-2 px-2")`
+    - `btn.to_cls("mt-2 px-2")` # it will merge classes to btn default syle
+
+  * If you are using Tailwind css then add yaml files to your tailwind config content section.
+    i.e
+    ```
+    content: [
+      "./styles/*.yaml"
+    ],
+    ```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/EloquentStudio/classic. 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/EloquentStudio/classic/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 Classic project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/EloquentStudio/classic/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/classic/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Classic
+  class Configuration
+    attr_accessor :files, :file_prefix, :raise_error_on_not_found, :classes_merge_handler,
+      :auto_reload_on_change
+
+    def validate!
+      if files.nil? || files.empty?
+        raise Classic::Error, "'files' option value is required."
+      end
+    end
+  end
+end

data/lib/classic/manager.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require "json"
+require "yaml"
+
+module Classic
+  # Store and Proces styles.
+  class Manager
+    BASE_STYLE_KEY = "base"
+    DEFAULT_STYLE_KEY = "default"
+    SELF_STYLE_KEY = "<self"
+    ALIASES_KEY = "@aliases"
+
+    attr_reader :config, :data, :entries, :merged_css_entries
+
+    def initialize(config:)
+      @config = config
+      @classes_merge_handler = config.classes_merge_handler
+    end
+
+    def files
+      config.files
+    end
+
+    def load
+      @data = {}
+      @entries = {}
+      @merged_css_entries = Hash.new({})
+
+      files.each do |file|
+        extname = File.extname(file)
+        file_data = (extname == "json") ? JSON.load_file(file) : YAML.load_file(file)
+        aliases = file_data.delete(ALIASES_KEY) if file_data.key?(ALIASES_KEY)
+
+        if config.file_prefix
+          prefix = File.basename(file).gsub(extname, "")
+          @data[prefix] = file_data
+          build_aliases(aliases, prefix: prefix)
+        else
+          @data.merge!(file_data) do |key, old_value, new_value|
+            raise Classic::Error, "dublicate value found for #{key} - values #{old_value}, #{new_value}"
+          end
+
+          build_aliases(aliases)
+        end
+      end
+    end
+
+    def cls(name, classes = nil)
+      return (@entries[name] ||= lookup(name)) unless classes
+
+      @merged_css_entries[name][classes] ||= @classes_merge_handler.call([lookup(name), classes])
+    end
+
+    def lookup(name)
+      component = @data[name] || name
+
+      component_path = if component.is_a?(String)
+        name
+      elsif component.is_a?(Hash)
+        # default value is style expression(i.e varient.default,size.default)) then add componet name
+        # (i.e btn(varient.default,size.default)))
+        # else add default to component name(i.e btn) with "." i.e(btn.default)
+        if component.key?(DEFAULT_STYLE_KEY)
+          if component[DEFAULT_STYLE_KEY].match?(STYLE_EXP_REGX)
+            "#{name}#{component[DEFAULT_STYLE_KEY]}"
+          else
+            "#{name}.#{DEFAULT_STYLE_KEY}"
+          end
+        elsif component.key?(SELF_STYLE_KEY)
+          "#{name}.#{SELF_STYLE_KEY}"
+        end
+      end
+
+      if component_path
+        style_fn = parse(component_path)
+        classes = collect_styles(style_fn)
+
+        return style_not_found_value(name) if classes.nil? || classes.empty?
+
+        classes = classes.join(" ") if classes.is_a?(Array)
+        classes.strip.tr("\n", " ")
+      else
+        style_not_found_value(name)
+      end
+    end
+
+    # Matches:
+    #  btn(varient.default,size.default)
+    #  (varient.default,size.default)
+    STYLE_EXP_REGX = /([\w.]*)\(([\w.,\s]*)\)/
+
+    def parse(style)
+      matches = style.scan(STYLE_EXP_REGX)
+
+      if matches.any?
+        component, options = matches.first
+
+        if component.empty?
+          component = options
+          options = ""
+        end
+      else
+        component = style
+        options = ""
+      end
+
+      { component: component, options: options.split(",").map(&:strip), name: style }
+    end
+
+    def collect_styles(style_fn)
+      component = nil
+
+      style_fn[:component].split(".").each do |c|
+        c = c.strip
+        component = component ? component[c] : @data[c]
+      end
+
+      # If component is direct css class. i.e "flex flex-col space-y-1.5 p-6"
+      return style_not_found_value(style_fn[:name]) unless component
+
+      # In case of i.e "card.header" component is end result css classes.
+      return component if component.is_a?(String)
+
+      if style_fn[:options].empty?
+        # Handle "label" -> will lookup "label.<self"
+        return component[SELF_STYLE_KEY] if component.key?(SELF_STYLE_KEY)
+
+        # Handle "btn.size" -> will lookup "btn.size.default"
+        return component[DEFAULT_STYLE_KEY] if component.key?(DEFAULT_STYLE_KEY)
+      end
+
+      styles = []
+      # If component is a Hash and has 'base' entry and has style options
+      # i.e
+      # btn:
+      #   base: rounded-md text-sm font-medium...
+      styles << component[BASE_STYLE_KEY] if component.key?(BASE_STYLE_KEY)
+
+      style_fn[:options].each do |o|
+        option = nil
+
+        o.split(".").each do |c|
+          c = c.strip
+          option = option ? option[c] : component[c]
+        end
+
+        if option
+          styles << option
+        else
+          style_not_found_value(style_fn[:name])
+        end
+      end
+
+      styles
+    end
+
+    def style_not_found_value(name)
+      raise NotFoundError, "'#{name}' style not found." if config.raise_error_on_not_found
+
+      "#{name}-StyleNotFound"
+    end
+
+    def build_aliases(aliases, prefix: nil)
+      aliases&.each do |name, style|
+        if prefix
+          @entries["#{prefix}.#{name}"] = lookup("#{prefix}.#{style}")
+        else
+          @entries[name] = lookup(style)
+        end
+      end
+    end
+  end
+end

data/lib/classic/railtie.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Classic
+  # Auto loader on style files change.
+  class Railtie < Rails::Railtie
+    config.after_initialize do |app|
+      Classic::Railtie.watch_style_files(app)
+    end
+
+    def self.watch_style_files(app)
+      style_files = Classic.object.files.map { |f| Rails.root.join(f).to_s }
+      reloader = app.config.file_watcher.new(style_files) {}
+      app.reloaders << reloader
+      app.reloader.to_run do
+        reloader.execute_if_updated { Classic.reload! }
+      end
+    end
+  end
+end

data/lib/classic/string_ext.rb

@@ -0,0 +1,7 @@
+module Classic
+  class ::String
+    def to_cls(classes = nil)
+      Classic.cls(self, classes)
+    end
+  end
+end

data/lib/classic/version.rb

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

data/lib/classic.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "classic/version"
+require_relative "classic/string_ext"
+require_relative "classic/configuration"
+require_relative "classic/manager"
+require_relative "classic/railtie" if Object.const_defined?("Rails::Railtie")
+
+module Classic
+  class Error < StandardError; end
+
+  class NotFoundError < StandardError; end
+
+  def self.configure
+    config = Configuration.new
+    yield config
+    config.classes_merge_handler ||= proc { |classes| classes.join(" ") }
+    config.validate!
+
+    @classic = Classic::Manager.new(config: config)
+    @classic.load
+
+    if config.auto_reload_on_change && Object.const_defined?("Rails::Railtie")
+      Classic::Railtie.initializers.each(&:run)
+    end
+  end
+
+  def self.reload!
+    @classic.load
+  end
+
+  def self.object
+    @classic
+  end
+
+  def self.cls(name, classes = nil)
+    @classic.cls(name, classes)
+  end
+end

data/sig/classic.rbs

@@ -0,0 +1,4 @@
+module Classic
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: classic
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jiren Patel
+bindir: exe
+cert_chain: []
+date: 2025-01-16 00:00:00.000000000 Z
+dependencies: []
+description: A comprehensive utility library designed to standardize and simplify
+  the management of styles across web application and cache styles. This library facilitates
+  consistent styling, theme management and dynamically combine components styles i.e
+  varient,size.
+email:
+- jiren@eloquent.studio
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/classic.rb
+- lib/classic/configuration.rb
+- lib/classic/manager.rb
+- lib/classic/railtie.rb
+- lib/classic/string_ext.rb
+- lib/classic/version.rb
+- sig/classic.rbs
+homepage: https://github.com/EloquentStudio/classic
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/EloquentStudio/classic
+  source_code_uri: https://github.com/EloquentStudio/classic
+  changelog_uri: https://github.com/EloquentStudio/classic
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A comprehensive utility library designed to standardize and simplify the
+  management of styles across web application.
+test_files: []