tailwindcss-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 465ca9281b589424b1a007d5bfbcb89034320a000f5d899118edbe91025a7e40
+  data.tar.gz: ba1a1fb55f9bdfa63e844cc3de171e10e96af3e3ddfe7c4503eae7b2d5b79b1f
+SHA512:
+  metadata.gz: 8bfd4b6f430ffd48cf8bf9f9d5b25c088f655025e7ff911c5bede8160c555045038b2c2d035d97a4bbfc86db3890d94fb9166d1a3afe72f043f973c3867ffc47
+  data.tar.gz: 1fb7dca1f70798606a5182ddbca025a1592a420a5e2fff8b4e3a04f84e16d7b801179e83aa948d4ad6a3e7e1082b0a71798b766bc208e32c792ab60a5c5a2db2

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-28
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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 guilherme.andrade.ao@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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tailwindcss.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+group :development do
+  gem "pry"
+end

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    tailwindcss-rb (0.1.0)
+      activesupport (~> 7.0)
+      deep_merge (~> 1.0)
+      dry-configurable (~> 1.0)
+      listen
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
+    deep_merge (1.2.2)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    dry-configurable (1.2.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-core (1.0.1)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    ffi (1.17.0)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    method_source (1.1.0)
+    minitest (5.24.1)
+    mutex_m (0.2.0)
+    parallel (1.25.1)
+    parser (3.3.4.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.8.0)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    regexp_parser (2.9.2)
+    rexml (3.3.2)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.65.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    strscan (3.1.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    zeitwerk (2.6.16)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  tailwindcss-rb!
+
+BUNDLED WITH
+   2.4.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Guilherme Andrade
+
+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,244 @@
+# Tailwindcss-rb
+
+This is a ruby gem that adds a ruby-like library and compiler for tailwindcss. It's goal is to serve as a an atomic set of functions
+that help you build your own UI framework in ruby.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tailwindcss'
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+And run the installer:
+
+```bash
+bundle exec rake tailwindcss:install
+```
+
+
+## Basic Usage
+
+At its core of the gem, is the `Style` class. This class is used to generate tailwindcss classes in a ruby-like way.
+
+```ruby
+Tailwindcss::Style.new(bg: :red).to_s
+# => "bg-red-500"
+```
+
+Or using the `tailwind` helper.
+
+```ruby
+include Tailwindcss::Helpers
+
+tailwind(bg: :red, text: :white)
+# => "bg-red-500 text-white"
+```
+
+## Configuration
+
+You can configure the gem by creating an initializer file in your rails app.
+
+```ruby
+# config/initializers/tailwindcss.rb
+
+Tailwindcss.configure do |config|
+  config.package_json_path = "./package.json"
+  config.config_file_path = "./tailwind.config.js"
+  config.compiler.output_path = "./public/assets/styles.css"
+  config.compiler.compile_classes_dir = "./tmp/tailwindcss"
+  config.content = []
+  config.prefix = ""
+  config.watch_content = false
+  config.breakpoints = %i[xs sm md lg xl 2xl]
+  config.pseudo_selectors = %i[hover focus active visited disabled first last first_of_type last_of_type odd even group_hover]
+  config.pseudo_elements = %i[before after file first_letter first_line selection backdrop marker]
+  config.logger = Logger.new(STDOUT)
+  config.theme.color_scheme = {
+    primary: :red,
+    secondary: :blue,
+    tertiary: :green
+  }
+  # other theme configurations
+end
+```
+
+## Compiling your styles
+
+You can compile your styles by running the following command.
+
+```bash
+bundle exec rake tailwindcss:compile
+```
+
+Or by starting a process that watches for changes.
+
+```bash
+bundle exec rake tailwindcss:compile:watch
+```
+
+### How it works
+
+The `tailwindcss-rb` compiler parses through the files in the `config.content`, and attempts to stactically extract the arguments you pass to the `tailwind` helper method. It then generates the tailwindcss classes and writes them to the `config.compiler.output_path`.
+
+This file is then used by the tailwindcss compiler to generate the final css file.
+
+##### Example
+
+Given that you configured the gem as follows:
+
+```ruby
+Tailwindcss.configure do |config|
+  config.content = [
+    "app/views/**/*.html.erb",
+  ]
+end
+```
+
+And that you're writing the following code in your view file:
+
+```erb
+# app/views/layouts/application.html.erb
+
+<div class="<%= tailwind(bg: :red, text: :white) %>">
+  Hello World
+</div>
+```
+
+The compiler will generate the following "classes" file.
+
+```
+bg-red-500 text-white
+```
+
+And these classes will be added by the tailwind compiler to the final css file.
+
+
+### Recommended use in development
+
+When making changes related to your css, it is recommended that you set up a process that watches for changes and compiles the css file.
+
+You can either do this by running the following command in a separate terminal window:
+
+```bash
+bundle exec rake tailwindcss:compile:watch
+```
+
+Or by adding the following line to your `Procfile.dev` file when using foreman.
+
+```yaml
+tailwindcss: bundle exec rake tailwindcss:compile:watch
+```
+
+### Recommended use in production
+
+When deploying to production, it is recommended that you compile the css file before deploying.
+
+You can do this by running the following command:
+
+```bash
+bundle exec rake tailwindcss:compile
+```
+
+### Heroku
+
+If you're deploying to heroku, you can add the following line to your `Procfile` file to make sure the css file is compiled before deploying.
+
+```yaml
+release: bundle exec rake tailwindcss:compile
+```
+
+### Uploading to a CDN
+
+If you're uploading your assets to a CDN, you can add the following line to your `Rakefile` to make sure the css file is compiled before uploading.
+
+```ruby
+task "assets:precompile" => "tailwindcss:compile"
+```
+
+And make sure that your configuration is set up to use the correct file url in helpers.
+
+```ruby
+Tailwindcss.configure do |config|
+  config.tailwind_css_file_path = proc { "https://cdn.example.com/assets/styles.css" }
+end
+```
+> We're currently working on a fix to make this easier to configure and support fingerprinting.
+
+## Advanced Usage
+
+### Using Modifiers
+
+Any key that starts with an underscore is considered a modifier. Modifiers are used to add pseudo classes and elements to the class.
+
+```ruby
+tailwind(bg: :red, text: :white, _hover: { bg: :blue })
+# => "bg-red-500 text-white hover:bg-blue-500"
+
+tailwind(bg: :red, text: :white, _hover: { bg: :blue }, _before: { content: '[""]' })
+# => "bg-red-500 text-white hover:bg-blue-500 before:content-[\"\"]"
+```
+
+
+### Using arbitrary values
+
+When using arbitrary values, you have one of two options.
+
+1. Wrap the value in `[]` to use the value as is.
+
+```ruby
+tailwind(bg: "[url('image.png')]")
+# => "bg-[url('image.png')]"
+```
+
+2. Use the `ab` method to add arbitrary values.
+
+```ruby
+include Tailwindcss::Helpers
+
+tailwind(bg: ab("url('image.png')"))
+```
+
+### Using color scheme values
+
+You can use the color scheme values by using the `color_scheme_token` method.
+
+```ruby
+Tailwindcss.configure do |config|
+  config.theme.color_scheme = {
+    primary: :red,
+    secondary: :blue,
+    tertiary: :green
+  }
+end
+
+tailwind(bg: color_scheme_token(:primary))
+# => "bg-red-500"
+```
+
+Optionally, you can specify a shade.
+
+```ruby
+tailwind(bg: color_scheme_token(:primary, 100))
+# => "bg-red-100"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/guilherme-andrade/tailwindcss-rb.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## 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.
+

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "bundler/setup"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+Dir.glob('lib/tasks/**/*.rake').each { |r| load r }

data/lib/tailwindcss/arbitrary_value.rb

@@ -0,0 +1,15 @@
+module Tailwindcss
+  class ArbitraryValue
+    def initialize(value)
+      @value = value
+    end
+
+    def to_s
+      "[#{@value}]"
+    end
+
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/tailwindcss/asset_helper.rb

@@ -0,0 +1,15 @@
+module Tailwindcss
+  module AssetHelper
+    include ActionView::Helpers::AssetTagHelper
+
+    extend self
+
+    def tailwind_stylesheet_path
+      Tailwindcss.tailwind_css_file_path
+    end
+
+    def view_component_ui_asset_tags
+      stylesheet_link_tag(tailwind_stylesheet_path)
+    end
+  end
+end

data/lib/tailwindcss/compiler/channel.rb

@@ -0,0 +1,18 @@
+require "tailwindcss/asset_helper"
+
+module Tailwindcss
+  module Compiler
+    class Channel < ActionCable::Channel::Base
+      extend AssetHelper
+
+      def subscribed
+        stream_from "compiler_channel"
+      end
+
+      def self.broadcast_css_changed
+        css_path = vite_asset_path("style.css")
+        ActionCable.server.broadcast("compiler_channel", {css_path:})
+      end
+    end
+  end
+end

data/lib/tailwindcss/compiler/connection.rb

@@ -0,0 +1,6 @@
+module Tailwindcss
+  module Compiler
+    class Connection < ActionCable::Connection::Base
+    end
+  end
+end

data/lib/tailwindcss/compiler/file_classes_extractor.rb

@@ -0,0 +1,24 @@
+module Tailwindcss
+  module Compiler
+    class FileClassesExtractor
+      require "tailwindcss/compiler/output"
+      require "tailwindcss/compiler/file_parser"
+
+      def call(file_path:)
+        ast = file_parser.call(file_path:)
+        return unless ast
+
+        hash_args = hash_args_extractor.call(ast:)
+        hash_args.map { class_list_builder.call(**_1) }.flatten.compact
+      end
+
+      private
+
+      def hash_args_extractor = HashArgsExtractor.new
+
+      def file_parser = FileCompiler.new
+
+      def class_list_builder = StyleAttributesToListConverter.new
+    end
+  end
+end

data/lib/tailwindcss/compiler/file_parser.rb

@@ -0,0 +1,55 @@
+module Tailwindcss
+  module Compiler
+    class FileCompiler
+      require "parser/current"
+      require "tailwindcss/compiler/hash_args_extractor"
+
+      def call(file_path:)
+        file_content = File.read(file_path)
+        code = if file_is_ruby?(file_path:)
+          extract_ruby_from_rb(file_content:)
+        elsif file_is_erb?(file_path:)
+          extract_ruby_from_erb(erb: file_content)
+        else
+          return
+        end
+
+        buffer = Parser::Source::Buffer.new(file_path)
+        buffer.source = code
+
+        parser = Parser::CurrentRuby.new
+        parser.parse(buffer)
+      rescue Parser::SyntaxError
+        Rails.logger.error("Tailwindcss: Failed to parse #{file_path}. Skipping...")
+      end
+
+      private
+
+      def file_is_ruby?(file_path:)
+        file_path.end_with?(".rb")
+      end
+
+      def file_is_erb?(file_path:)
+        file_path.end_with?(".html.erb")
+      end
+
+      def erb_template_in_ruby?(file_path:)
+        file_is_ruby?(file_path:) && File.read(file_path).match?(/<<(~|-)ERB/)
+      end
+
+      def extract_ruby_from_rb(file_content:)
+        [file_content, erb_code_from_rb(file_content:)].flatten.compact.join("\n")
+      end
+
+      def erb_code_from_rb(file_content:)
+        match_erb = file_content.match(/<<[~-]ERB(.*)ERB/m)
+        extract_ruby_from_erb(erb: match_erb[1]) if match_erb
+      end
+
+      def extract_ruby_from_erb(erb:)
+        # Use a regex to extract ruby code from ERB
+        erb.scan(/<%=?([\s\S]*?)%>/m).flatten.compact.join("\n")
+      end
+    end
+  end
+end