essence 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41a46dd9be7eb9ea84ba3ca4ad2f3a20333154644472673c347117bd6fb6b652
-  data.tar.gz: 3fd04819b2f327760571d3ec200a7300c45b7a4d7627b425e969a6999a051925
+  metadata.gz: f9be2e0f4b7e7288c5cf845c54d67988f472a967ebdd04b6d01ac790c1d1c7a4
+  data.tar.gz: f1ebff9a5f1f108042f48f3241edc2cd5d8998d9605b20d6e52bed3b338219dc
 SHA512:
-  metadata.gz: 5688120d6baf34e1de5049978bd7a8b63f18bfd9dae45ab8acfbe3096b42f36168c5408502e7d4fc24bdafb4cda29fa1e7db77469fc3b6cd297ec685e89bb0a7
-  data.tar.gz: 9067b68f43129af1e0d5e4398b1d3682cf10bb05b0e06898ba708cec4d79e531e00129998a4697306c1b229fb139f33b985980c6216129a04279c1d02fb8e4d9
+  metadata.gz: 067d0df4723dd420b5100d7c21c417f37e959e62e325154fcd3671a22b3b919d51720e6b6a911233a8791065d0a3a93a9b931c0111b5e4b90454aa6c8648b80c
+  data.tar.gz: 06d8732651332803411614ae867fd3e78ae226853992fd3d0367bc441054925d6647d4c2151d0c3e0af4b24990b8a24891c8042f816789cd454cda9f5197e03d

data/README.md

@@ -2,11 +2,53 @@
 
 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
 
-TBA
+#### 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
 

data/lib/essence/components/avatar.rb

@@ -0,0 +1,35 @@
+# 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 overflow-hidden"
+
+  SIZES = {
+    sm: "size-6 text-[0.5rem]",
+    md: "size-8 text-xs",
+    lg: "size-12 text-sm"
+  }
+
+  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) do
+      img(src: attributes[:src], alt: attributes[:alt]) if attributes[:src]
+      yield if block_given?
+    end
+  end
+
+  def fallback(**attrs, &)
+    div(**attrs, &)
+  end
+
+  def construct_classes(classes)
+    TAILWIND_MERGER.merge([ BASE, SIZES[size], classes ].compact)
+  end
+end

data/lib/essence/components/badge.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+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: "",
+    sm: "text-[0.65rem] px-2 py-0.5 gap-1 min-w-8",
+    md: "text-xs px-2.5 py-1 gap-2 min-w-12",
+    lg: "text-sm px-4 py-1 gap-2 min-w-16"
+  }
+  KINDS = {
+    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
+  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(&)
+    div(**attributes, &)
+  end
+
+  private
+
+  def construct_classes(classes)
+    TAILWIND_MERGER.merge([ BASE, SIZES[size], KINDS[kind], classes ].compact)
+  end
+end

data/lib/essence/components/button.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 class Essence::Button < Essence::Essence
-  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"
-
+  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",
@@ -11,7 +10,6 @@ class Essence::Button < Essence::Essence
     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",

data/lib/essence/components/link.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Essence::Link < Essence::Essence
-  CLASS = "inline-flex items-center gap-1 font-medium text-gray-900 border-b-2 hover:border-gray-900 transition-colors"
+  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::Essence
 
   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::Essence
-  CLASS = "flex gap-4"
-
+  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::Essence
   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::Essence
   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::Essence
-  CLASSES = "animate-pulse bg-gray-200/55 rounded-xs"
+  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.2.0"
+  VERSION = "0.2.2"
 end

data/lib/essence.rb

@@ -4,12 +4,13 @@ require "tailwind_merge"
 
 module Essence
   # Autoloading
-  autoload :Component, "essence/components/component"
-
+  autoload :Avatar, "essence/components/avatar"
+  autoload :Badge, "essence/components/badge"
   autoload :Button, "essence/components/button"
+  # autoload :Essence, "essence/components/essence" # Base component
   autoload :Link, "essence/components/link"
-  autoload :Skeleton, "essence/components/skeleton"
   autoload :Row, "essence/components/row"
+  autoload :Skeleton, "essence/components/skeleton"
 
   autoload :CLI, "essence/cli"
 
@@ -19,20 +20,24 @@ module Essence
   def self.component_class_names
     @component_class_names ||= {
       essence: "Essence::Essence",
+      avatar: "Essence::Avatar",
+      badge: "Essence::Badge",
       button: "Essence::Button",
       link: "Essence::Link",
-      skeleton: "Essence::Skeleton",
       row: "Essence::Row",
+      skeleton: "Essence::Skeleton",
     }
   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,
+      skeleton: ::Essence::Skeleton,
     }
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: essence
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Elvinas Predkelis
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-18 00:00:00.000000000 Z
+date: 2024-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -74,6 +74,8 @@ files:
 - 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