essence 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a9516a2911b410deb58ca4b9ba2afbf083752314b0bb6df0018c81a4615f14d
-  data.tar.gz: 51074c18359021237cc4588b64a858aed0464746d5b9d0f0513319e722b73828
+  metadata.gz: b698fdfbf94b34b4afa01e1c6f38a2e9ac2feca00f34166c0acead4c4e6c8e40
+  data.tar.gz: b11e693d29dbc9bd6763725692570bffb8879cafb32967cc1c34a2fbc5c65881
 SHA512:
-  metadata.gz: a94fccdf29ea63f7fd807b786f8bd477ac44feb623a19bae66814412d6c170536b15ec46f8f02266c5bf6afbc0db61f2c30e95f2b58e5a6dbb3288a807af18ac
-  data.tar.gz: 8e49f1011e3ddbecf3b37f3f5a0bd257b94061eab3053c8f06f616f3a60cd5f179688f9deacda83eb6ccb9129c48a0c47c6b8607fe5ca80c36e9b22e379c5dec
+  metadata.gz: b95a0636aca009728061fc524f93bfeacf2728aa846e7e6ff7afa8918ba99ce1a47ba80ef8bc44863d982c0cb8cc1ef760f61f9c367b9cddd9beda463de5798c
+  data.tar.gz: 371fb23359faf1f9e5835394c2fea1952813d7f43bf0f008704b641dca2d50faa2463c371869d1511a8625a22b9416ac8d2c3b59f09ceae36ca1c1e6fc865d29

data/README.md

@@ -0,0 +1,55 @@
+# Essence
+
+A simple, ergonomic and performant component library for Ruby applications.
+
+<a href="https://rubygems.org/gems/essence">
+  <img alt="Essence GEM Version" src="https://img.shields.io/gem/v/essence?color=10b981&include_prereleases&logo=ruby&logoColor=f43f5e">
+</a>
+
+<a href="https://rubygems.org/gems/essence">
+  <img alt="Essence GEM Version" src="https://img.shields.io/gem/dt/essence?color=10b981&include_prereleases&logo=ruby&logoColor=f43f5e">
+</a>
+
+---
+
+### Features
+
+- Tailored components - Designed using flexibility in mind while streamlining the development process
+- Gorgeous simplicity - Essence empowers minimalistic user interface with purposeful accents
+- Geared for performance - Keep everything in one place. No spreadsheets or getting lost between tooling
+- Ergonomic approach - Essence is designed to be easy to use and understand
+
+---
+
+## Installation
+
+#### Add gem
+
+Simply add the gem to your Gemfile by running the following command
+
+```bash
+bundle add essence
+```
+
+#### Install Essence
+
+Run the installation command and we'll take care of the rest
+
+```bash
+bundle exec essence install
+```
+
+More information on about the installation can be found in the [documentation](https://essence.primevise.com/installation)
+
+## Who uses Essence?
+
+- [Mintis](https://mintis.app)
+- [Hansa](https://hansahq.com)
+- [Release Server](https://releaseserver.com)
+- [College Life Work](https://work.collegelife.co)
+
+Do you use Essence in your project? Let us know!
+
+## Licence
+
+MIT

data/exe/essence

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require_relative "../lib/essence"
+
+Essence::CLI.call

data/lib/essence/cli/add.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Essence
+  module CLI
+    class Add < Dry::CLI::Command
+      desc "Add an Essence component to your project"
+      argument :component_name, required: true, desc: "Component name"
+      example Essence.component_names
+
+      def call(*args)
+        component_name = args[0][:component_name]
+
+        return puts "> #{component_name}: component unsupported" unless Essence.component_names.include?(component_name.to_sym)
+
+        Essence::CLI::Commands.copy_component(component_name:)
+        Essence::CLI::Commands.replace_component_contents(component_name:)
+        Essence::CLI::Commands.replace_component_contents(
+          component_name:,
+          from: Essence::CLI::Commands::COMPONENT_DEFINITION_SUFFIX,
+          to: Essence::CLI::Commands::PHLEX_COMPONENT_DEFINITION_SUFFIX
+        )
+
+        puts "> Successfully added #{component_name} component to #{Essence::CLI::Commands::DESTINATION_DIR.join("#{component_name}.rb")}"
+      end
+    end
+  end
+end

data/lib/essence/cli/install.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Essence
+  module CLI
+    class Install < Dry::CLI::Command
+      BASE_COMPONENT_NAME = "essence"
+      BASE_DEFINITION_PREFIX = "class Essence::Essence"
+      PHLEX_BASE_DEFINITION_PREFIX = "class Components::Essence"
+
+      desc "Install Essence to your project"
+      def call(*)
+        puts "> Installing Essence..."
+        puts "> Copying base component to your project"
+        Essence::CLI::Commands.copy_component(component_name: BASE_COMPONENT_NAME)
+        Essence::CLI::Commands.replace_component_contents(
+          component_name: BASE_COMPONENT_NAME,
+          from: BASE_DEFINITION_PREFIX,
+          to: PHLEX_BASE_DEFINITION_PREFIX
+        )
+        # Essence::CLI::Commands.rename_component_file(
+        #   from: Essence::CLI::Commands::DESTINATION_DIR.join("#{BASE_COMPONENT_NAME}.rb"),
+        #   to: Essence::CLI::Commands::DESTINATION_DIR.join("essence.rb")
+        # )
+        puts "> Essence has been successfully installed!"
+      end
+    end
+  end
+end

data/lib/essence/cli/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Essence
+  module CLI
+    class Version < Dry::CLI::Command
+      desc "Print Essence version"
+
+      def call(*)
+        puts Essence::VERSION
+      end
+    end
+  end
+end

data/lib/essence/cli.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "dry/cli"
+
+# CLI Commands
+require_relative "cli/add"
+require_relative "cli/install"
+require_relative "cli/version"
+
+module Essence
+  module CLI
+    def self.call(*args)
+      Dry::CLI.new(Commands).call
+    end
+
+    module Commands
+      extend Dry::CLI::Registry
+
+      # Constants
+      COMPONENTS_DIR = Pathname.new(File.expand_path("components", __dir__))
+      DESTINATION_DIR = Pathname.new(File.expand_path(Dir.pwd)).join("app/components")
+      COMPONENT_DEFINITION_PREFIX = "class Essence::"
+      COMPONENT_DEFINITION_SUFFIX = "< Essence::Essence"
+      PHLEX_COMPONENT_DEFINITION_PREFIX = "class Components::"
+      PHLEX_COMPONENT_DEFINITION_SUFFIX = "< Components::Essence"
+
+      # Registering commands
+      register "add", Add, aliases: ["a", "generate", "g"]
+      register "install", Install, aliases: ["i"]
+      register "version", Version, aliases: ["v", "-v", "--version"]
+
+      private
+
+      # UTILITIES
+      def self.copy_component(component_name:)
+        source_path = COMPONENTS_DIR.join("#{component_name}.rb")
+        destination_path = DESTINATION_DIR.join("#{component_name}.rb")
+
+        FileUtils.mkdir_p(DESTINATION_DIR)
+        FileUtils.copy(source_path, destination_path)
+      end
+
+      def self.replace_component_contents(
+        component_name:,
+        from: COMPONENT_DEFINITION_PREFIX,
+        to: PHLEX_COMPONENT_DEFINITION_PREFIX
+      )
+        component_file = DESTINATION_DIR.join("#{component_name}.rb")
+        return unless File.exist?(component_file)
+
+        replaced_content = File.read(component_file).gsub(from, to)
+        File.write(component_file, replaced_content)
+      end
+
+      def self.rename_component_file(from:, to:)
+        return if from.nil? || to.nil?
+        return unless File.exist?(from)
+
+        FileUtils.mv(from, to)
+      end
+    end
+  end
+end

data/lib/essence/components/avatar.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class Essence::Button < Essence::Essence
+  BASE = "inline-flex items-center justify-center w-fit rounded-xs border border-transparent font-medium transition duration-150 cursor-pointer disabled:opacity-50 disabled:cursor-not-allowed hover:opacity-90"
+  SIZES = {
+    none: "",
+    xs: "text-[0.6rem] px-2 py-1.5 gap-1",
+    sm: "text-xs px-3 py-2 gap-1.5",
+    md: "text-sm px-4 py-2 gap-2",
+    lg: "text-base px-6 py-2.5 gap-2.5",
+    xl: "text-base px-8 py-3 gap-3"
+  }
+  KINDS = {
+    primary: "text-white bg-indigo-500 hover:bg-indigo-500",
+    secondary: "text-gray-700 bg-gray-100 hover:bg-gray-200",
+    critical: "text-white bg-rose-500 hover:bg-rose-400",
+    warning: "text-white bg-amber-500 hover:bg-amber-400",
+    success: "text-white bg-emerald-500 hover:bg-emerald-400",
+    info: "text-white bg-blue-500 hover:bg-blue-400",
+    dark: "text-white bg-gray-900 hover:bg-gray-800",
+    white: "text-gray-900 bg-white hover:bg-gray-200",
+    ghost: "text-gray-900 bg-white hover:bg-gray-200 hover:text-gray-800"
+  }
+
+  attr_reader :size
+  attr_reader :kind
+  attr_reader :attributes
+
+  def initialize(size: :md, kind: :primary, **attributes)
+    @size = size
+    @kind = kind
+    @attributes = attributes
+    @attributes[:class] = construct_classes(@attributes[:class])
+  end
+
+  def view_template(&)
+    element_tag(**attributes, &)
+  end
+
+  private
+
+  def element_tag(...)
+    attributes[:href] ? a(...) : button(...)
+  end
+
+  def construct_classes(classes)
+    TAILWIND_MERGER.merge([ BASE, SIZES[size], KINDS[kind], classes ].compact)
+  end
+end

data/lib/essence/components/badge.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Essence::Avatar < Essence::Essence
+  BASE = "border border-transparent rounded-full bg-gray-100 aspect-square inline-flex items-center justify-center font-medium text-gray-700"
+  SIZES = {
+    sm: "size-6 text-xs",
+    md: "size-8 text-sm",
+    lg: "size-12 text-base"
+  }
+
+  attr_reader :attributes
+  attr_reader :size
+
+  def initialize(size: :md, **attributes)
+    @size = size
+    @attributes = attributes
+    @attributes[:class] = construct_classes(@attributes[:class])
+  end
+
+  def view_template(&)
+    div(**attributes, &)
+  end
+
+  def fallback(**attrs, &)
+    span(**attrs, &)
+  end
+
+  def construct_classes(classes)
+    TAILWIND_MERGER.merge([ BASE, SIZES[size], classes ].compact)
+  end
+end

data/lib/essence/components/button.rb

@@ -1,27 +1,21 @@
 # frozen_string_literal: true
 
-class Essence::Button < Essence::Component
-  BASE = "inline-flex items-center rounded-xs border border-transparent font-medium transition duration-150 cursor-pointer disabled:opacity-50 disabled:cursor-not-allowed hover:opacity-90"
-
+class Essence::Badge < Essence::Essence
+  BASE = "inline-flex items-center justify-center w-fit rounded-full border border-transparent font-medium transition duration-150 hover:opacity-90"
   SIZES = {
     none: "",
-    xs: "text-[0.6rem] px-2 py-1.5 gap-1",
-    sm: "text-xs px-3 py-2 gap-1.5",
-    md: "text-sm px-4 py-2 gap-2",
-    lg: "text-base px-6 py-2.5 gap-2.5",
-    xl: "text-base px-8 py-3 gap-3"
+    sm: "text-[0.65rem] px-2 py-0.5 gap-1",
+    md: "text-xs px-2.5 py-1 gap-2",
+    lg: "text-sm px-4 py-1.5 gap-2"
   }
-
   KINDS = {
-    primary: "text-white bg-indigo-500 hover:bg-indigo-500",
-    secondary: "text-gray-700 bg-gray-100 hover:bg-gray-200",
-    critical: "text-white bg-rose-500 hover:bg-rose-400",
-    warning: "text-white bg-amber-500 hover:bg-amber-400",
-    success: "text-white bg-emerald-500 hover:bg-emerald-400",
-    info: "text-white bg-blue-500 hover:bg-blue-400",
-    dark: "text-white bg-gray-900 hover:bg-gray-800",
-    white: "text-gray-900 bg-white hover:bg-gray-200",
-    ghost: "text-gray-900 bg-white hover:bg-gray-200 hover:text-gray-800"
+    primary: "text-gray-900 border-gray-200",
+    success: "text-white bg-emerald-500",
+    critical: "text-white bg-rose-500",
+    warning: "text-white bg-amber-500",
+    info: "text-white bg-blue-500",
+    dark: "text-white bg-gray-900",
+    white: "text-gray-900 bg-white"
   }
 
   attr_reader :size
@@ -36,16 +30,13 @@ class Essence::Button < Essence::Component
   end
 
   def view_template(&)
-    element_tag(**attributes, &)
+    div(**attributes, &)
   end
 
   private
 
-  def element_tag(...)
-    attributes[:href] ? a(...) : button(...)
-  end
-
   def construct_classes(classes)
     TAILWIND_MERGER.merge([ BASE, SIZES[size], KINDS[kind], classes ].compact)
   end
+
 end

data/lib/essence/{component.rb → components/essence.rb}

@@ -1,4 +1,6 @@
-class Essence::Component < Phlex::HTML
+class Essence::Essence < Phlex::HTML
+  extend Phlex::Kit
+
   TAILWIND_MERGER = ::TailwindMerge::Merger.new.freeze unless defined?(TAILWIND_MERGER)
 
   attr_reader :attributes

data/lib/essence/components/link.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-class Essence::Link < Essence::Component
-  CLASS = "inline-flex items-center gap-1 font-medium text-gray-900 border-b-2 hover:border-gray-900 transition-colors"
+class Essence::Link < Essence::Essence
+  BASE = "inline-flex w-fit items-center gap-1 font-medium text-gray-900 border-b-2 hover:border-gray-900 transition-colors"
   KINDS = {
     regular: "border-transparent",
     underline: "border-gray-200"
@@ -11,7 +11,7 @@ class Essence::Link < Essence::Component
 
   def initialize(kind: :regular, **attributes)
     @attributes = attributes
-    @attributes[:class] = @attributes[:class] ? TAILWIND_MERGER.merge([ CLASS, @attributes[:class] ]) : CLASS
+    @attributes[:class] = @attributes[:class] ? TAILWIND_MERGER.merge([ BASE, @attributes[:class] ]) : BASE
   end
 
   def view_template(&)

data/lib/essence/components/row.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-class Essence::Row < Essence::Component
-  CLASS = "flex gap-4"
-
+class Essence::Row < Essence::Essence
+  BASE = "flex gap-4"
   KINDS = {
     default: "flex-col md:flex-row md:items-center md:justify-between",
     center: "flex-col md:flex-row md:items-center md:justify-center",
@@ -16,7 +15,7 @@ class Essence::Row < Essence::Component
   def initialize(kind: :default, **attributes)
     @kind = kind
     @attributes = attributes
-    @attributes[:class] = @attributes[:class] ? TAILWIND_MERGER.merge([ CLASS, KINDS[kind], @attributes[:class] ]) : CLASS
+    @attributes[:class] = @attributes[:class] ? TAILWIND_MERGER.merge([ BASE, KINDS[kind], @attributes[:class] ]) : BASE
   end
 
   def view_template(&)
@@ -24,6 +23,6 @@ class Essence::Row < Essence::Component
   end
 
   def item(**attrs, &)
-    div(class: TAILWIND_MERGER.merge([ "flex items-center gap-2 flex-wrap", iattrs[:class] ]), **attrs, &)
+    div(class: TAILWIND_MERGER.merge([ "flex items-center gap-2 flex-wrap", attrs[:class] ]), **attrs, &)
   end
 end

data/lib/essence/components/skeleton.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-class Essence::Skeleton < Essence::Component
-  CLASSES = "animate-pulse bg-gray-200/55 rounded-xs"
+class Essence::Skeleton < Essence::Essence
+  BASE = "animate-pulse bg-gray-200/55 rounded-xs"
 
   def initialize(**attributes)
     @attributes = attributes
-    @attributes[:class] = @attributes[:class] ? TAILWIND_MERGER.merge([ CLASSES, @attributes[:class] ]) : CLASSES
+    @attributes[:class] = @attributes[:class] ? TAILWIND_MERGER.merge([ BASE, @attributes[:class] ]) : BASE
   end
 
   def view_template(&)

data/lib/essence/version.rb

@@ -1,3 +1,3 @@
 module Essence
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/essence.rb

@@ -1,11 +1,46 @@
+# frozen_string_literal: true
+
 require "tailwind_merge"
 
 module Essence
   # Autoloading
-  autoload :Component, "essence/component"
+  autoload :Component, "essence/components/component"
 
   autoload :Button, "essence/components/button"
   autoload :Link, "essence/components/link"
   autoload :Skeleton, "essence/components/skeleton"
   autoload :Row, "essence/components/row"
+
+  autoload :CLI, "essence/cli"
+
+  # Components
+  # Class names and classes are separated to avoid loading in Phlex into the CLI tooling
+
+  def self.component_class_names
+    @component_class_names ||= {
+      essence: "Essence::Essence",
+      avataro: "Essence::Avatar",
+      badge: "Essence::Badge",
+      button: "Essence::Button",
+      link: "Essence::Link",
+      skeleton: "Essence::Skeleton",
+      row: "Essence::Row",
+    }
+  end
+
+  def self.component_classes
+    @components_classes ||= {
+      essence: ::Essence::Essence,
+      avatar: ::Essence::Avatar,
+      badge: ::Essence::Badge,
+      button: ::Essence::Button,
+      link: ::Essence::Link,
+      skeleton: ::Essence::Skeleton,
+      row: ::Essence::Row,
+    }
+  end
+
+  def self.component_names
+    @component_names ||= component_class_names.keys
+  end
 end

metadata

@@ -1,16 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: essence
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Elvinas Predkelis
 - Primevise
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2024-12-15 00:00:00.000000000 Z
+date: 2024-12-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: phlex
   requirement: !ruby/object:Gem::Requirement
@@ -42,13 +62,22 @@ dependencies:
 description: Component library for Ruby applications using Phlex
 email:
 - info@primevise.com
-executables: []
+executables:
+- essence
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- exe/essence
 - lib/essence.rb
-- lib/essence/component.rb
+- lib/essence/cli.rb
+- lib/essence/cli/add.rb
+- lib/essence/cli/install.rb
+- lib/essence/cli/version.rb
+- lib/essence/components/avatar.rb
+- lib/essence/components/badge.rb
 - lib/essence/components/button.rb
+- lib/essence/components/essence.rb
 - lib/essence/components/link.rb
 - lib/essence/components/row.rb
 - lib/essence/components/skeleton.rb