tailwind_theme-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af4a596650d11be93a96ed08a70b8155b5865c1ff40c3053b3b4a39ee6585fc3
+  data.tar.gz: 787ff82ef8f220ec9bdd71c880bf50ead8775e2e41727c0237d88244aea6a3be
+SHA512:
+  metadata.gz: bdfa4e58b4079e6204b90a6476cb6e5b87e8b636781ef3efbaca6947eb742fb998be868d08bed4b76f9019d84bcb9f8d869cbf7ed4691bc34619d18759603602
+  data.tar.gz: cfc8b8ea25b3a6997b16e2423ff7ddf9eb88f223712dbd36543424098b6af585524251935e1560d21a19a0520dfd02018c736b8354dc8cbb93276baa6c725231

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright James Fawks
+
+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,28 @@
+# TailwindTheme::Rails
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "tailwind_theme-rails"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install tailwind_theme-rails
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/tailwind_theme/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/tailwind_theme/install/install_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module TailwindTheme
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __dir__)
+
+      desc "Creates a default TailwindTheme file."
+
+      class_option :erb
+
+      def copy_default_theme
+        @theme_name = "default"
+        template "theme.yml", "config/theme.yml#{".erb" if !!options[:erb]}"
+      end
+
+      def copy_alternative_theme
+        @theme_name = "alternative"
+        template "theme.yml", "config/themes/alternative.yml#{".erb" if !!options[:erb]}"
+      end
+    end
+  end
+end

data/lib/generators/tailwind_theme/templates/theme.yml

@@ -0,0 +1,6 @@
+_theme: "<%= @theme_name %>"
+component:
+  disabled?: "opacity-50"
+  variant:
+    solid: "bg-blue-500"
+    outline: "border border-blue-500"

data/lib/tailwind_theme/controller_concern.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module TailwindTheme
+  # Adds the methods and helpers to the controller for setting and getting the TailwindTheme
+  module ControllerConcern
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_theme # :nodoc:
+
+      # Add the helper method for the views
+      helper_method :theme
+    end
+
+    class_methods do
+      # Set the TailwindTheme for the controller
+      #e
+      # @param [String, Symbol, NilClass] name the name of the theme to use. Defaults to nil.
+      #
+      # When `name` is nil, :default, or "default", the default theme will be used.
+      #
+      # See the [Factory](#Factory) class for more details
+      def theme(name)
+        self._theme = name
+      end
+    end
+
+    # The specified TailwindTheme for the controller
+    def theme
+      theme_factory.theme self.class._theme
+    end
+
+    private
+
+    def theme_factory
+      Factory.new
+    end
+  end
+end

data/lib/tailwind_theme/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TailwindTheme
+  class Engine < ::Rails::Engine # :nodoc:
+
+
+    initializer "tailwind_theme.setup_controller_theme" do |app|
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.include TailwindTheme::ControllerConcern
+      end
+    end
+  end
+end

data/lib/tailwind_theme/factory.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module TailwindTheme
+  # Theme factory to load and cache a theme.
+  #
+  # @example
+  #
+  #     TailwindTheme::Factory.new.theme
+  #
+  # @example
+  #
+  #     TailwindTheme::Factory.new.theme :admin
+  #
+  class Factory
+    def initialize(config_dir = nil)
+      @config_dir = config_dir || ::Rails.root.join("config").to_s
+      @themes = {}
+    end
+
+    # Load and cache the theme.
+    #
+    # @param [String, Symbol] name the name of the theme to load. Nil will load the default theme.
+    #
+    # The default theme load order:
+    #   1) themes/default.yml(.erb)
+    #   2) theme.yml(.erb)
+    #
+    # @return [TailwindTheme::Theme, NilClass] returns the theme or nil if the theme cannot be found.
+    def theme(name = nil)
+      if name.nil? || name.to_s == "default"
+        default_theme
+      else
+        theme_by_name name
+      end
+    end
+
+    private
+
+    def default_theme
+      return @themes[:default] if @themes[:default]
+
+      files = Dir[
+        File.expand_path("themes/default.{yml,yml.erb}"),
+        File.expand_path("theme.{yml,yml.erb}", @config_dir)
+      ]
+
+      load_theme :default, files
+    end
+
+    def theme_by_name(name)
+      return @themes[name.to_sym] if @themes[name.to_sym]
+
+      files = Dir[File.expand_path("themes/#{name}.{yml,yml.erb}", @config_dir)]
+      load_theme name, files
+    end
+
+    def load_theme(name, files)
+      return if files.empty?
+
+      theme = TailwindTheme.load_file files.first.to_s
+      theme.instance_eval <<-RUBY
+def name
+  "#{name}"
+end
+      RUBY
+
+      @themes[name.to_sym] = theme
+    end
+  end
+end

data/lib/tailwind_theme/rails/version.rb

@@ -0,0 +1,5 @@
+module TailwindTheme
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/tailwind_theme-rails.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "rails"
+require "tailwind_theme"
+require "tailwind_theme/rails/version"
+require "tailwind_theme/factory"
+require "tailwind_theme/controller_concern"
+require "tailwind_theme/engine"

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: tailwind_theme-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Fawks
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tailwind_theme
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description:
+email:
+- hello@jfawks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/generators/tailwind_theme/install/USAGE
+- lib/generators/tailwind_theme/install/install_generator.rb
+- lib/generators/tailwind_theme/templates/theme.yml
+- lib/tailwind_theme-rails.rb
+- lib/tailwind_theme/controller_concern.rb
+- lib/tailwind_theme/engine.rb
+- lib/tailwind_theme/factory.rb
+- lib/tailwind_theme/rails/version.rb
+homepage: https://github.com/jefawks3/tailwind_theme-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jefawks3/tailwind_theme-rails
+  source_code_uri: https://github.com/jefawks3/tailwind_theme-rails
+  changelog_uri: https://github.com/jefawks3/tailwind_theme-rails/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Rails helpers for TailwindTheme
+test_files: []