element_component 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb69cb724b6274a5f95967fbabef32f6e1f5fb9bbf2428775a3237708cc7d6da
-  data.tar.gz: 50b2252d0c9315efc8c660910d0924dc6506552d09cbd1fc2f49e2309174f2ba
+  metadata.gz: 9ebf642383684b4ac3419d63b6538ab4ddccc14c6275ad9913e2aa4d6fd14938
+  data.tar.gz: 1bfd4f8d575c2f92804c7c62868e3c303ca8a01f6238addee9d4bf93cd3b6d68
 SHA512:
-  metadata.gz: 98abc01a0787f60a2998f7f62c611fe51a58eaa8ee629e4bfc885da7ccf6b3a11a9e1f2539d206cfa379222caf5d821206f31558e9f7c47afe1ffa9a3addcaf8
-  data.tar.gz: bb664c8ad1a7f627f43f1f44898937efeb9c3fc916fca6a65c0b6ae01e1267326d0cff703e476f3748f41cb589b4c0f7c40f236b4787849efcb2029897b3ce78
+  metadata.gz: 99e132b0e8a5e168dfb9bae745cb46c235a3249ef42e61263bbbd4ae384472523ac5d110a3dc3afe12fec1a0436defd795afdd227f36efa11f515d4eb64a52f1
+  data.tar.gz: 5d721e3aa5aefc886c74eea0a04c94e9d408417b6e5660ef6976e5f8ea603e13f1c2c4ef9b559e256532e195e289f14ebe9cf60820cd33efbc492da731133296

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2025 João Paulo Correia
+Copyright (c) 2023 João Paulo Correia
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 # ElementComponent
 
-HTML builder
+A lightweight and flexible HTML builder for Ruby. `ElementComponent` provides a simple, object-oriented way to construct HTML structures programmatically, allowing for dynamic attribute management and content nesting.
 
 ## Installation
 
@@ -18,37 +18,79 @@ gem install element_component
 
 ## Usage
 
+### Basic Usage
+
+Create a simple element and render it to HTML:
+
+```ruby
+p = ElementComponent::Element.new("p", class: "text-bold")
+p.add_content("Hello, World!")
+puts p.render
+# => <p class="text-bold">Hello, World!</p>
+```
+
+### Nesting Elements
+
+You can nest elements by adding another `ElementComponent::Element` instance as content:
+
+```ruby
+div = ElementComponent::Element.new("div", class: "container")
+h1  = ElementComponent::Element.new("h1")
+h1.add_content("Welcome")
+
+div.add_content(h1)
+div.add_content("This is a simple HTML builder.")
+
+puts div.render
+# => <div class="container"><h1>Welcome</h1>This is a simple HTML builder.</div>
+```
+
+### Attribute Management
+
+`ElementComponent` allows for easy manipulation of HTML attributes:
+
 ```ruby
-maker = ElementComponent::Core::Maker.new
-form = maker.form(attribute: { class: 'has-background-color', method: 'GET', action: '/', turbo: false }) do |form|
-  input = maker.input(attribute: { type: 'text', name: 'email', value: nil })
-  form.add_content input
+btn = ElementComponent::Element.new("button", class: "btn", type: "button")
+
+# Add more values to an attribute (e.g., adding another class)
+btn.add_attribute(class: "btn-primary")
 
-  button = maker.button(content: 'Save', attribute: { type: 'submit'})
-  div    = maker.div(content: button, attribute: { class: 'buttons' })
+# Reset attributes and set new ones
+btn.add_attribute!(id: "submit-btn", type: "submit")
 
-  form.add_content div
-end
+# Remove an attribute
+btn.remove_attribute(:type)
 
-puts form.build
+# Remove a specific value from an attribute
+btn.remove_attribute_value(:class, "btn-primary")
 ```
 
-## Output
+### Self-Closing Tags
 
-```html
-<form class="has-background-color" method="GET" action="/" turbo="false"><input type="text" name="email" value=""></input><div class="buttons"><button type="submit">Save</button></div></form>
+You can specify if an element should have a closing tag:
+
+```ruby
+img = ElementComponent::Element.new("img", closing_tag: false, src: "image.png", alt: "Logo")
+puts img.render
+# => <img src="image.png" alt="Logo">
 ```
 
+### Rendering Hooks
+
+`ElementComponent` supports `before_render`, `after_render`, and `around_render` hooks if implemented in a subclass or by extending an instance.
+
 ## 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.
 
 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).
 
-## TODO
-[ ] - Cache
-[ ] - Bulma components
-[ ] - Bootstrap components
+## Roadmap
+
+- [ ] Support for Caching
+- [ ] Pre-built Bulma components
+- [ ] Pre-built Bootstrap components
+- [ ] Enhanced DSL for nested structures
 
 ## Contributing
 

data/lib/element_component/element.rb

@@ -0,0 +1,108 @@
+module ElementComponent
+  class Element
+    attr_reader :element, :attributes, :contents, :html
+
+    def initialize(element, closing_tag: true, **attribute)
+      @element = element
+      @closing_tag = closing_tag
+      @html = ""
+
+      add_attribute!(attribute)
+      reset_contents!
+    end
+
+    def add_content!(content)
+      reset_contents!
+
+      add_content(content)
+    end
+
+    def add_content(content = nil, &block)
+      if block_given?
+        @contents.push(block)
+      else
+        @contents.push(content)
+      end
+
+      self
+    end
+
+    def add_attribute!(hash_attr)
+      reset_attributes!
+
+      add_attribute(hash_attr)
+    end
+
+    def add_attribute(hash_attr)
+      hash_attr.each_key do |attr|
+        @attributes[attr] = [] unless @attributes.key?(attr)
+
+        hash_attr[attr]
+          .to_s
+          .split
+          .each do |value|
+            @attributes[attr].push(value)
+          end
+      end
+
+      self
+    end
+
+    def remove_attribute(attribute)
+      @attributes = @attributes.except(attribute)
+    end
+
+    def remove_attribute_value(attribute, value)
+      attributes[attribute].delete(value)
+    end
+
+    def reset_contents!
+      @contents = []
+    end
+
+    def reset_attributes!
+      @attributes = {}
+    end
+
+    def new_element(*args, **kargs) = Element.new(*args, **kargs)
+
+    def render
+      before_render if respond_to? 'before_render'
+
+      if respond_to? 'around_render'
+        around_render { build }
+      else
+        build
+      end
+
+      after_render(@html) if respond_to? 'after_render'
+
+      @html
+    end
+
+    private
+
+    def build
+      @html << "<#{@element}"
+      @html << (mount_attributes.empty? ? ">" : " #{mount_attributes}>")
+      @html << mount_content
+      @html << "</#{@element}>" if @closing_tag
+      @html
+    end
+
+    def mount_attributes
+      @attributes.map { |attr| "#{attr[0].to_sym}=\"#{attr[1].join(" ")}\"" }.join(" ")
+    end
+
+    def mount_content
+      @contents.map do |content|
+        case content
+        in Element
+          content.render
+        else
+          content.to_s
+        end
+      end.join
+    end
+  end
+end

data/lib/element_component/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module ElementComponent
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/element_component.rb

@@ -1,8 +1,5 @@
-# frozen_string_literal: true
-
 require_relative "element_component/version"
-require_relative "element_component/core/element"
-require_relative "element_component/core/maker"
+require_relative "element_component/element"
 
 module ElementComponent
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: element_component
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - João Paulo Correia
@@ -11,7 +11,7 @@ date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: HTML Builder
 email:
-- ijoohn@hotmail.com
+- joaopaulocorreia1010@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -22,10 +22,8 @@ files:
 - README.md
 - Rakefile
 - lib/element_component.rb
-- lib/element_component/core/element.rb
-- lib/element_component/core/maker.rb
+- lib/element_component/element.rb
 - lib/element_component/version.rb
-- sig/element_component.rbs
 homepage: https://github.com/joaopaulocorreia/element_component
 licenses:
 - MIT
@@ -46,7 +44,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: HTML Builder
 test_files: []

data/lib/element_component/core/element.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module ElementComponent
-  module Core
-    class Element
-      attr_reader :element, :attributes, :contents
-
-      def initialize(element, content: [], attribute: {}, closing_tag: true)
-        @element = element
-        @closing_tag = closing_tag
-        @objects = []
-
-        reset_attributes!
-        reset_contents!
-
-        if content.is_a? Array
-          content.each { |item| add_content item }
-        else
-          add_content content
-        end
-
-        attribute.each_key { |key| add_attribute key, attribute[key] }
-      end
-
-      def add_content(content, reset: false)
-        reset_contents! if reset
-        @contents.push(content)
-
-        content
-      end
-
-      def add_attribute(attribute, value, reset: false)
-        attribute = attribute.to_sym
-
-        @attributes.delete attribute if reset
-
-        return @attributes[attribute].push(value) if @attributes.key?(attribute)
-
-        @attributes[attribute] = [value]
-      end
-
-      def remove_attribute!(attribute)
-        attribute = attribute.to_sym
-        @attributes = @attributes.except(attribute)
-      end
-
-      def remove_attribute_value(attribute, value)
-        attribute = attribute.to_sym
-        attributes[attribute].delete(value)
-      end
-
-      def reset_contents!
-        @contents = []
-      end
-
-      def reset_attributes!
-        @attributes = {}
-      end
-
-      def build
-        html = "<#{@element}"
-        html << (mount_attributes.empty? ? ">" : " #{mount_attributes}>")
-
-        html << mount_content
-
-        html << "</#{@element}>" if @closing_tag
-      end
-
-      private
-
-      def mount_attributes
-        @attributes.map { |attr| "#{attr[0].to_sym}=\"#{attr[1].join(" ")}\"" }.join(" ")
-      end
-
-      def mount_content
-        @contents.map { |content| content.is_a?(Element) ? content.build : content.to_s }.join
-      end
-    end
-  end
-end

data/lib/element_component/core/maker.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module ElementComponent
-  module Core
-    class Maker
-      def method_missing(method, **args, &block)
-        new_element = ElementComponent::Core::Element.new(method.to_s.gsub("_", "-"), **args)
-        block.call new_element if block_given?
-        new_element
-      end
-    end
-  end
-end

data/sig/element_component.rbs

@@ -1,4 +0,0 @@
-module ElementComponent
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end