sinatra-tailwind 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2adf0d518dcafc6441d65f9c586c2a17a839ce442ca88b5088551788fd8d5c67
-  data.tar.gz: 741f619b7ddee2dbc3e47844af9658d26447c18ff1bae3040afa7ab278c3b0aa
+  metadata.gz: c92a01438e966f40aa88e8c1131137f1c29f1b4e7b3bf1f2bd251c642138544c
+  data.tar.gz: 764a3fb4462ff4b8b5ab4479614cdea4aa3776ae085876fafab437221a9c5516
 SHA512:
-  metadata.gz: 66b945fec628f24efad692692c3618f82d8ee41a211c5a4c3358c6de753bbfb9be1a2cdeaa61d9c5e0703a3320ac4d5907480401d47a469735934dcd25f7a09e
-  data.tar.gz: 615224da5d977707657a6932b2ac4e8fb0825606cf1fafe8f8b6e929e9fc787e77106bd3c9aee7cc62e6c37320ee454c8dadf6e4a11dff9a297fae36ff532519
+  metadata.gz: b85386eda60128a27bcd65a0fa5734c3a2cff37de854f3ad599c9328a40fcb2c12599e98fe3ca299eb151034e53ec0a8a6d384a86c35dde6d799474d0eb1e43f
+  data.tar.gz: e647693b10642fdfbf2dcaddb8bb4a131dc97948c455e1252ce8ba78326ab43d28a331e13819d16abfa41975cdb37711c9a931f36c511de2ed99c2e0ae48aa96

data/README.md

@@ -1,43 +1,133 @@
 # Sinatra::Tailwind
 
-TODO: Delete this and the text below, and describe your gem
+Simple TailwindCSS integration for Sinatra applications.
 
-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/sinatra/tailwind`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Overview
 
-## Installation
+Sinatra::Tailwind provides zero-configuration TailwindCSS setup for Sinatra applications. This gem offers:
 
-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.
+- 🚀 Instant setup with smart defaults
+- 🔄 Automatic CSS reloading
+- 🛠 Production-ready builds
+- 📦 Zero configuration
+- 🎨 Full TailwindCSS features
 
-Install the gem and add to the application's Gemfile by executing:
+## Installation
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+Add to your Gemfile:
+
+```ruby
+gem 'sinatra-tailwind'
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Then run:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle install
+bundle exec tailwind install
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Add the stylesheet to your layout:
+
+```erb
+<!-- views/layout.erb -->
+<link rel="stylesheet" href="/css/application.min.css">
+```
+
+2. Use TailwindCSS in your views:
+
+```erb
+<div class="container mx-auto p-4">
+  <h1 class="text-3xl font-bold">Hello World</h1>
+</div>
+```
 
 ## 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.
+Start the development server:
 
-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).
+```bash
+./bin/dev
+```
+
+Or manually:
+
+```bash
+bundle exec tailwind watch  # Watch CSS changes
+bundle exec ruby app.rb     # Run Sinatra server
+```
+
+## Commands
+
+```bash
+tailwind install  # Install TailwindCSS
+tailwind watch   # Watch for changes
+tailwind build   # Build for production
+tailwind setup   # Configure development
+```
+
+## Project Structure
+
+```
+my-app/
+├── app.rb
+├── Procfile.dev
+├── bin/
+│   └── dev
+├── views/
+│   └── layout.erb
+└── public/
+    └── css/
+        ├── application.css
+        └── application.min.css
+```
+
+## Configuration
+
+TailwindCSS configuration is available in `tailwind.config.js`:
+
+```js
+module.exports = {
+  content: [
+    './views/**/*.{erb,haml,slim}',
+    './public/**/*.{html,js}'
+  ],
+  theme: {
+    extend: {},
+  },
+  plugins: [],
+}
+```
+
+## Example Application
+
+```ruby
+# app.rb
+require 'sinatra'
+require 'sinatra/tailwind'
+
+class MyApp < Sinatra::Base
+  register Sinatra::Tailwind
+
+  get '/' do
+    erb :index
+  end
+end
+```
+
+## Support
+
+- 📘 [Documentation](https://github.com/aristotelesbr/sinatra-tailwind/wiki)
+- 🐛 [Issue Tracker](https://github.com/aristotelesbr/sinatra-tailwind/issues)
+- 💬 [Discussions](https://github.com/aristotelesbr/sinatra-tailwind/discussions)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sinatra-tailwind. 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]/sinatra-tailwind/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
+[MIT License](LICENSE)
 
-Everyone interacting in the Sinatra::Tailwind project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sinatra-tailwind/blob/master/CODE_OF_CONDUCT.md).

data/exe/tailwind

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sinatra/tailwind/cli"
+
+Sinatra::Tailwind::CLI.start(ARGV)

data/lib/sinatra/tailwind/cli.rb

@@ -0,0 +1,113 @@
+require "thor"
+require "sinatra/tailwind/setup"
+require "tty-prompt"
+
+module Sinatra
+  module Tailwind
+    class CLI < Thor
+      include Thor::Actions
+      include Sinatra::Tailwind::Setup
+
+      map %w[--version -v] => :version
+
+      desc "version", "Show sinatra-tailwind version"
+      def version
+        require "sinatra/tailwind/version"
+        say "sinatra-tailwind version #{Sinatra::Tailwind::VERSION}"
+      end
+
+      desc "install", "Install TailwindCSS in your Sinatra application"
+      def install
+        say "\n🎨 Installing TailwindCSS for your Sinatra application...", :blue
+
+        check_npm_installation
+        install_tailwind_dependencies
+        create_tailwind_config
+        create_css_file
+        setup_build_process
+
+        if ask_setup_procfile?
+          invoke :setup
+        end
+
+        say "\n✨ TailwindCSS installation completed successfully!", :green
+        say "\n👉 You can now run:", :blue
+        say "  bundle exec tailwind build  - To build your CSS", :cyan
+        say "  bundle exec tailwind watch  - To watch for CSS changes", :cyan
+        say "  bundle exec tailwind setup  - To setup Procfile.dev", :cyan if !File.exist?("Procfile.dev")
+      rescue Error => e
+        say "\n❌ Error: #{e.message}", :red
+        exit 1
+      end
+
+      desc "build", "Build TailwindCSS files"
+      def build
+        if system("which npm > /dev/null 2>&1")
+          say "\n🔨 Building CSS files...", :blue
+          if system("npm run build:css")
+            say "✨ CSS build completed successfully!", :green
+          else
+            say "\n❌ Error: Failed to build CSS", :red
+            exit 1
+          end
+        else
+          say "\n❌ Error: NPM is not installed", :red
+          exit 1
+        end
+      end
+
+      desc "watch", "Watch for CSS changes and rebuild"
+      def watch
+        if system("which npm > /dev/null 2>&1")
+          say "\n👀 Watching for changes...", :blue
+          exec("npx tailwindcss -i ./public/css/application.css -o ./public/css/application.min.css --watch")
+        else
+          say "\n❌ Error: NPM is not installed", :red
+          exit 1
+        end
+      end
+
+      desc "setup", "Setup Procfile.dev for development"
+      def setup
+        if File.exist?("Procfile.dev")
+          if yes?("\n⚠️  Procfile.dev already exists. Do you want to override it?", :yellow)
+            create_procfile
+            create_dev_script
+          end
+        else
+          create_procfile
+          create_dev_script
+        end
+
+        say "\n✨ Development environment setup completed!", :green
+        say "\n👉 To start your development server, run:", :blue
+        say "  ./bin/dev", :cyan
+      end
+
+      private
+
+      def ask_setup_procfile?
+        prompt = TTY::Prompt.new(enable_color: true)
+        prompt.yes?("\n🤔 Would you like to setup a Procfile.dev for development? (y/n)", default: true)
+      end
+
+      def create_procfile
+        say "\n📝 Creating Procfile.dev...", :blue
+
+        content = <<~PROCFILE
+          web: bundle exec rackup -p ${PORT:-9292}
+          css: bundle exec tailwind watch
+        PROCFILE
+
+        create_file "Procfile.dev", content
+
+        if !system("which foreman > /dev/null 2>&1")
+          say "\n⚠️  Note: You need to install foreman to use Procfile.dev", :yellow
+          say "  Run: gem install foreman", :cyan
+        end
+
+        say "✨ Procfile.dev created successfully!", :green
+      end
+    end
+  end
+end

data/lib/sinatra/tailwind/setup.rb

@@ -0,0 +1,164 @@
+require "fileutils"
+require "json"
+require "logger"
+
+module Sinatra
+  module Tailwind
+    module Setup
+      def check_npm_installation
+        unless system("which npm > /dev/null 2>&1")
+          raise Error, "NPM is not installed. Please install Node.js and NPM first."
+        end
+      end
+
+      def install_tailwind_dependencies
+        if !File.exist?("package.json")
+          log_info "📦 Initializing new Node.js project..."
+
+          package_json = {
+            "name" => "tailwind-app",
+            "version" => "1.0.0",
+            "private" => true,
+            "dependencies" => {},
+            "devDependencies" => {}
+          }
+
+          File.write("package.json", JSON.pretty_generate(package_json))
+        end
+
+        begin
+          package_json = JSON.parse(File.read("package.json"))
+
+          if !package_json.dig("dependencies", "tailwindcss")
+            log_info "📦 Installing TailwindCSS..."
+            if !system("npm install tailwindcss@latest --save --legacy-peer-deps")
+              raise Error, "Failed to install TailwindCSS"
+            end
+          end
+
+          dev_dependencies = package_json["devDependencies"] || {}
+          needed_dev_deps = ["postcss", "autoprefixer"] - dev_dependencies.keys
+
+          if !needed_dev_deps.empty?
+            log_info "📦 Installing development dependencies..."
+            if !system("npm install #{needed_dev_deps.join(" ")} --save-dev --legacy-peer-deps")
+              raise Error, "Failed to install development dependencies"
+            end
+          end
+
+          package_json = JSON.parse(File.read("package.json"))
+
+          clean_deps = {"tailwindcss" => package_json.dig("dependencies", "tailwindcss")}
+          package_json["dependencies"] = clean_deps
+
+          dev_deps = package_json["devDependencies"] || {}
+          clean_dev_deps = {
+            "postcss" => dev_deps["postcss"],
+            "autoprefixer" => dev_deps["autoprefixer"]
+          }.compact
+          package_json["devDependencies"] = clean_dev_deps
+
+          File.write("package.json", JSON.pretty_generate(package_json))
+
+          if !system("npm install --legacy-peer-deps")
+            raise Error, "Failed to reinstall dependencies"
+          end
+        rescue JSON::ParserError => e
+          raise Error, "Failed to parse package.json: #{e.message}"
+        rescue => e
+          raise Error, "An error occurred during dependency installation: #{e.message}"
+        end
+      end
+
+      def create_tailwind_config
+        return if File.exist?("tailwind.config.js")
+
+        log_info "🔧 Creating Tailwind configuration..."
+        config_content = <<~JS
+          module.exports = {
+            content: [
+              './views/**/*.{erb,haml,slim}',
+              './public/**/*.{html,js}'
+            ],
+            theme: {
+              extend: {},
+            },
+            plugins: [],
+          }
+        JS
+
+        File.write("tailwind.config.js", config_content)
+      end
+
+      def create_css_file
+        css_dir = "public/css"
+        css_file = "#{css_dir}/application.css"
+        return if File.exist?(css_file)
+
+        log_info "🎨 Creating CSS file..."
+        FileUtils.mkdir_p(css_dir)
+        css_content = <<~CSS
+          @tailwind base;
+          @tailwind components;
+          @tailwind utilities;
+        CSS
+
+        File.write(css_file, css_content)
+      end
+
+      def setup_build_process
+        package_json = File.exist?("package.json") ? JSON.parse(File.read("package.json")) : {}
+        package_json["scripts"] ||= {}
+        package_json["scripts"]["build:css"] = "tailwindcss -i ./public/css/application.css -o ./public/css/application.min.css --minify"
+
+        File.write("package.json", JSON.pretty_generate(package_json))
+        log_info "⚙️  Added build script to package.json"
+      end
+
+      def create_dev_script
+        bin_dir = "bin"
+        dev_script = "#{bin_dir}/dev"
+
+        FileUtils.mkdir_p(bin_dir)
+
+        content = <<~BASH
+          #!/usr/bin/env bash
+
+          if ! command -v foreman &> /dev/null; then
+            echo "Installing foreman..."
+            gem install foreman
+          fi
+
+          if ! command -v npm &> /dev/null; then
+            echo "Error: NPM is required but not installed."
+            echo "Please install Node.js and NPM first."
+            exit 1
+          fi
+
+          if [ ! -f "Procfile.dev" ]; then
+            echo "Error: Procfile.dev not found."
+            echo "Please run 'bundle exec tailwind setup' first."
+            exit 1
+          fi
+
+          foreman start -f Procfile.dev "$@"
+        BASH
+
+        File.write(dev_script, content)
+        FileUtils.chmod(0o755, dev_script)
+
+        log_info "📝 Created bin/dev script"
+      end
+
+      private
+
+      def log_info(message)
+        logger.info(message)
+      end
+
+      def logger
+        @logger ||= Logger.new($stdout)
+      end
+    end
+  end
+end

data/lib/sinatra/tailwind/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Tailwind
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/sinatra/tailwind.rb

@@ -1,7 +1,20 @@
-require_relative "tailwind/version"
-require "sinatra/tailwind"
+require "sinatra/base"
+require "json"
+require "fileutils"
+require "sinatra/tailwind/version"
+require "sinatra/tailwind/setup"
+require "sinatra/tailwind/cli"
 
 module Sinatra
   module Tailwind
+    class Error < StandardError; end
+
+    class << self
+      def registered(app)
+        app.helpers Sinatra::Tailwind::Setup
+      end
+    end
   end
+
+  register Tailwind
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-tailwind
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aristóteles
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-29 00:00:00.000000000 Z
+date: 2024-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +124,8 @@ dependencies:
         version: '1.3'
 description: Integrate TailwindCSS in a Sinatra project
 email:
-executables: []
+executables:
+- tailwind
 extensions: []
 extra_rdoc_files: []
 files:
@@ -104,7 +133,10 @@ files:
 - README.md
 - bin/console
 - bin/setup
+- exe/tailwind
 - lib/sinatra/tailwind.rb
+- lib/sinatra/tailwind/cli.rb
+- lib/sinatra/tailwind/setup.rb
 - lib/sinatra/tailwind/version.rb
 homepage: https://github.com/aristotelesbr/sinatra-tailwind
 licenses:
@@ -132,5 +164,5 @@ requirements: []
 rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
-summary: Automated TailwindCSS integration for Sinatra applications
+summary: Zero-config TailwindCSS for Sinatra applications
 test_files: []