componeer 0.0.1a

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3c4b85f711607615e138a7a1f4e8daf968027a526397ac84049a771861ac1c1
+  data.tar.gz: b622a354a38801d06acd42905bbd93f5f5448bf093e21b11db75f5525fe74660
+SHA512:
+  metadata.gz: e73e90c188ccb86131457881a389a080b1b914378ce885a15cb75ac1e4278a19553905d48c76403603e64f70a0635b93e4b041a3b2028438bd43f6cda7a41a11
+  data.tar.gz: 2d4efb986f449539532ff30342e71cccf375c514ab2383d30d83bd5599c89748cf3d4965aad102917de3a80ef0da8933c8e6b34c37d9056ae7bbed465d94e9cd

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'Run bundle install to run rake tasks'
+end
+
+require 'rails'
+require 'combustion'
+
+Bundler.require :default, Rails.env
+Combustion.path = 'spec/dummy'
+Combustion::Application.configure_for_combustion
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+Combustion::Application.load_tasks

data/app/assets/config/componeer_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/componeer .css

data/app/components/componeer/base_component.rb

@@ -0,0 +1,34 @@
+module Componeer
+  class BaseComponent < ViewComponent::Base
+    def self.register_as(name)
+      name = name.to_s.to_sym
+
+      Componeer.register(name.to_sym, self)
+    end
+
+    def resolve_params(content_or_options, options)
+      if content_or_options.is_a?(Hash)
+        [nil, content_or_options]
+      else
+        [content_or_options, options]
+      end
+    end
+
+    def classes
+      @classes ||= [base_classes, custom_classes].flatten.compact_blank.uniq.join(' ')
+    end
+
+    def custom_classes
+      @custom_classes ||= options.delete(:class).to_s.split.compact_blank
+    end
+
+    def styles
+      @styles ||= begin
+        file_path = self.class.instance_method(:initialize).source_location[0]
+        styles_yaml_file = Rails.root.join(File.dirname(file_path), 'styles.yml')
+
+        File.exist?(styles_yaml_file) ? YAML.load(ERB.new(File.read(styles_yaml_file)).result) : {}
+      end
+    end
+  end
+end

data/app/components/componeer/buttons/button_component.html.erb

@@ -0,0 +1,3 @@
+<%= button_tag class: classes, **options do %>
+  <%= content.presence || text  %>
+<% end %>

data/app/components/componeer/buttons/button_component.rb

@@ -0,0 +1,25 @@
+module Componeer
+  module Buttons
+    class ButtonComponent < BaseComponent
+      register_as :button
+
+      attr_reader :text, :options, :custom_classes
+
+      def initialize(content_or_options = nil, options = {})
+        @text, @options = resolve_params(content_or_options, options)
+      end
+
+      def base_classes
+        [styles[:base],
+         styles.dig(:size, size),
+         styles.dig(:color, mode, color),
+         styles.dig(:shape, shape)]
+      end
+
+      def color = @color ||= @options.delete(:color) || :brand
+      def mode = @mode ||= @options.delete(:primary) ? :primary : :outlined
+      def size = @size ||= @options.delete(:size) || :medium
+      def shape = @shape ||= @options.delete(:shape) || :rounded
+    end
+  end
+end

data/app/components/componeer/buttons/styles.yml

@@ -0,0 +1,42 @@
+---
+:base: transition duration-300 ease-in-out
+:size:
+  :small: text-xs px-2.5 py-1.5
+  :medium: text-sm px-3 py-2
+  :large: text-base px-4 py-2
+:shape:
+  :rounded: rounded-md
+  :flat: rounded-none
+:color:
+  :outlined:
+    :brand: |
+      text-brand-500 border border-brand-500 hover:text-white hover:bg-brand-500
+      focus:ring-4 focus:ring-brand-300
+    :green: |
+      text-green-500 border border-green-500 hover:text-white hover:bg-green-500
+      focus:ring-4 focus:ring-green-300
+    :red: |
+      text-red-500 border border-red-500 hover:text-white hover:bg-red-500
+      focus:ring-4 focus:ring-red-300
+    :blue: |
+      text-indigo-500 border border-indigo-500 hover:text-white hover:bg-indigo-500
+      focus:ring-4 focus:ring-indigo-300
+    :yellow: |
+      text-yellow-400 border border-yellow-400 hover:text-white hover:bg-yellow-400
+      focus:ring-4 focus:ring-yellow-300
+    :orange: |
+      text-orange-400 border border-orange-400 hover:text-white hover:bg-orange-400
+      focus:ring-4 focus:ring-orange-300
+  :primary:
+    :brand: |
+      text-white bg-brand-500 hover:bg-brand-600 focus:ring-4 focus:ring-brand-300
+    :green: |
+      text-white bg-green-500 hover:bg-green-600 focus:ring-4 focus:ring-green-300
+    :red: |
+      text-white bg-red-500 hover:bg-red-600 focus:ring-4 focus:ring-red-300
+    :blue: |
+      text-white bg-indigo-500 hover:bg-indigo-600 focus:ring-4 focus:ring-indigo-300
+    :yellow: |
+      text-white bg-yellow-500 hover:bg-yellow-600 focus:ring-4 focus:ring-yellow-300
+    :orange: |
+      text-white bg-orange-400 hover:bg-orange-500 focus:ring-4 focus:ring-orange-300

data/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/app/controllers/componeer/application_controller.rb

@@ -0,0 +1,4 @@
+module Componeer
+  class ApplicationController < ::ApplicationController
+  end
+end

data/app/helpers/componeer/application_helper.rb

@@ -0,0 +1,4 @@
+module Componeer
+  module ApplicationHelper
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Componeer::Engine.routes.draw do
+  # Reserved for future use
+end

data/lib/componeer/configuration.rb

@@ -0,0 +1,9 @@
+module Componeer
+  class Configuration
+    attr_writer :include_componeer_helpers
+
+    def include_componeer_helpers?
+      @include_componeer_helpers.nil? ? true : @include_componeer_helpers.present?
+    end
+  end
+end

data/lib/componeer/engine.rb

@@ -0,0 +1,18 @@
+module Componeer
+  class Engine < ::Rails::Engine
+    isolate_namespace Componeer
+
+    initializer 'componeer.include_componeer_helpers' do |app|
+      app.config do |config|
+        config.to_prepare do
+          Componeer.config do |componeer_config|
+            if componeer_config.include_componeer_helpers?
+              ActiveSupport.on_load(:action_controller) { include Helpers }
+              ActiveSupport.on_load(:action_view) { include Helpers }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/componeer/helpers.rb

@@ -0,0 +1,32 @@
+module Componeer
+  module Helpers
+    def componeer
+      @componeer ||= Helper.new(self)
+    end
+    alias c componeer unless method_defined?(:c)
+
+    class Helper
+      delegate :render, to: :view_context
+
+      def initialize(view_context)
+        @view_context = view_context
+      end
+
+      def method_missing(method, *args, **kwargs, &)
+        if Componeer.registry.key?(method)
+          render(Componeer.registry[method].new(*args, **kwargs), &)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        Componeer.registry.key?(method) || super
+      end
+
+      private
+
+      attr_reader :view_context
+    end
+  end
+end

data/lib/componeer/registry.rb

@@ -0,0 +1,17 @@
+module Componeer
+  class Registry
+    delegate :key?, to: :components
+
+    attr_reader :components
+
+    def initialize
+      @components = {}
+    end
+
+    def register(name, component_klazz)
+      components[name] = component_klazz
+    end
+
+    delegate :[], to: :components
+  end
+end

data/lib/componeer/version.rb

@@ -0,0 +1,3 @@
+module Componeer
+  VERSION = '0.0.1a'.freeze
+end

data/lib/componeer.rb

@@ -0,0 +1,27 @@
+require 'componeer/version'
+require 'componeer/engine'
+require 'componeer/configuration'
+require 'componeer/helpers'
+require 'componeer/registry'
+
+module Componeer
+  def self.config
+    @config ||= Configuration.new.tap do |config|
+      yield config if block_given?
+    end
+  end
+
+  def self.registry
+    @registry ||= Registry.new
+  end
+
+  def self.register(*args)
+    registry.register(*args)
+  end
+
+  def self.eager_load!
+    path = File.expand_path('../app/components/**/*.rb', __dir__)
+
+    Dir[path].each { |file| require_dependency file }
+  end
+end

data/lib/install/componeer.rb

@@ -0,0 +1,3 @@
+run 'bundle add tailwindcss-rails'
+
+rails_command 'tailwindcss:install'

data/lib/tasks/componeer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :componeer do
+#   # Task goes here
+# end

data/lib/tasks/install.rake

@@ -0,0 +1,8 @@
+namespace :componeer do
+  desc 'Install Componeer'
+  task install: :environment do
+    location = File.expand_path('../install/componeer.rb', __dir__)
+
+    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{location}"
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: componeer
+version: !ruby/object:Gem::Version
+  version: 0.0.1a
+platform: ruby
+authors:
+- Andre Rodrigues
+- Mauricio Pereira
+- Lucas Pesqueira
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inline_svg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: |-
+  Componeer is a non-intrusive gem that enhances component-based development
+      in Ruby on Rails applications. It empowers developers to effortlessly build modular, reusable,
+      and highly maintainable UI components within their Rails projects. With an intuitive syntax and
+      comprehensive features, Componeer simplifies component management, promotes code reusability,
+      and enhances the scalability and flexibility of your Rails applications.
+email:
+- andrerpbts@gmail.com
+- mauriciopdvg@gmail.com
+- pesqueira.lucas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- app/assets/config/componeer_manifest.js
+- app/assets/stylesheets/componeer/application.css
+- app/components/componeer/base_component.rb
+- app/components/componeer/buttons/button_component.html.erb
+- app/components/componeer/buttons/button_component.rb
+- app/components/componeer/buttons/styles.yml
+- app/controllers/application_controller.rb
+- app/controllers/componeer/application_controller.rb
+- app/helpers/componeer/application_helper.rb
+- config/routes.rb
+- lib/componeer.rb
+- lib/componeer/configuration.rb
+- lib/componeer/engine.rb
+- lib/componeer/helpers.rb
+- lib/componeer/registry.rb
+- lib/componeer/version.rb
+- lib/install/componeer.rb
+- lib/tasks/componeer_tasks.rake
+- lib/tasks/install.rake
+homepage: https://docs.componeer.me
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://docs.componeer.me
+  source_code_uri: https://github.com/trytechlabs/componeer
+  changelog_uri: https://github.com/trytechlabs/componeer/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+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: 1.3.1
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A non-intrusive gem for component-based development in Ruby on Rails
+test_files: []