element_component 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0f12674a760bdf815e6ae25fccbadb96032dacc122eca06c9ad7335b91fe226
-  data.tar.gz: d912a66d464b5f0ead36c41faa7e20d12b5bbd56871f3112b922e11a9bc83aa9
+  metadata.gz: 9ebf642383684b4ac3419d63b6538ab4ddccc14c6275ad9913e2aa4d6fd14938
+  data.tar.gz: 1bfd4f8d575c2f92804c7c62868e3c303ca8a01f6238addee9d4bf93cd3b6d68
 SHA512:
-  metadata.gz: 25affca2d6a9f235d515060f943ebff6901fc2590f89a0b9782f4c43ce9f3d143cbcb8a2be976db48478328fbcdc903ba401bbeaa98901564f8f8f5f05f249a5
-  data.tar.gz: 19e19dccf1862858c47520a4afa3f0bf8aa364461dda3f30243c1d0400a49cdbb8a283c7aba3975a6cbb439d2f8aa7cf8cea5691663183cdc23c4237afbc5dc4
+  metadata.gz: 99e132b0e8a5e168dfb9bae745cb46c235a3249ef42e61263bbbd4ae384472523ac5d110a3dc3afe12fec1a0436defd795afdd227f36efa11f515d4eb64a52f1
+  data.tar.gz: 5d721e3aa5aefc886c74eea0a04c94e9d408417b6e5660ef6976e5f8ea603e13f1c2c4ef9b559e256532e195e289f14ebe9cf60820cd33efbc492da731133296

data/.rspec

@@ -1,3 +1,3 @@
 --format documentation
---require spec_helper
 --color
+--require spec_helper

data/.rubocop.yml

@@ -1,20 +1,22 @@
-# Mude para a versão de Ruby a ser utilizada e inclua aqui outros arquivos que
-# você considera importante que o RuboCop não execute como: node_modules, etc..
 AllCops:
- TargetRubyVersion: 3.1.2
- Exclude:
-   - 'bin/**/*'
+  TargetRubyVersion: 3.1
+  SuggestExtensions: false
+  NewCops: enable
 
 Documentation:
  Enabled: false
 
-Style/FrozenStringLiteralComment:
- Enabled: false
-
 Metrics/MethodLength:
   Enabled: false
-Metrics/AbcSize:
-  Enabled: false
 
 Metrics/BlockLength:
- ExcludedMethods: ['describe', 'context', 'feature', 'scenario', 'let']
+  Enabled: false
+
+Style/MissingRespondToMissing:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 TODO: Write your name
+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,36 +1,101 @@
 # ElementComponent
 
-Build html
+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
 
-Add this line to your application's Gemfile:
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add element_component
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install element_component
+```
+
+## Usage
+
+### Basic Usage
+
+Create a simple element and render it to HTML:
 
 ```ruby
-gem 'element_component'
+p = ElementComponent::Element.new("p", class: "text-bold")
+p.add_content("Hello, World!")
+puts p.render
+# => <p class="text-bold">Hello, World!</p>
 ```
 
-And then execute:
+### Nesting Elements
 
-    $ bundle install
+You can nest elements by adding another `ElementComponent::Element` instance as content:
 
-Or install it yourself as:
+```ruby
+div = ElementComponent::Element.new("div", class: "container")
+h1  = ElementComponent::Element.new("h1")
+h1.add_content("Welcome")
 
-    $ gem install element_component
+div.add_content(h1)
+div.add_content("This is a simple HTML builder.")
 
-## Usage
+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
+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")
+
+# Reset attributes and set new ones
+btn.add_attribute!(id: "submit-btn", type: "submit")
+
+# Remove an attribute
+btn.remove_attribute(:type)
+
+# Remove a specific value from an attribute
+btn.remove_attribute_value(:class, "btn-primary")
 ```
-maker = El::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
 
-  button = maker.button(content: 'Save', attribute: { type: 'submit'})
-  div    = maker.div(content: button, attribute: { class: 'buttons' })
+### Self-Closing Tags
 
-  form.add_content div
-end
+You can specify if an element should have a closing tag:
 
-puts form.build
+```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).
+
+## Roadmap
+
+- [ ] Support for Caching
+- [ ] Pre-built Bulma components
+- [ ] Pre-built Bootstrap components
+- [ ] Enhanced DSL for nested structures
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joaopaulocorreia/element_component.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

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.2.0'
+  VERSION = "0.5.0"
 end

data/lib/element_component.rb

@@ -1,10 +1,7 @@
-# frozen_string_literal: true
+require_relative "element_component/version"
+require_relative "element_component/element"
 
-# Core elements
-require_relative 'element_component/version'
-require_relative 'element_component/core/element'
-require_relative 'element_component/core/maker'
-
-module El
+module ElementComponent
   class Error < StandardError; end
+  # Your code goes here...
 end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: element_component
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - João Paulo Correia
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: 
+description: HTML Builder
 email:
 - joaopaulocorreia1010@gmail.com
 executables: []
@@ -19,22 +18,18 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - 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
-homepage: 
+homepage: https://github.com/joaopaulocorreia/element_component
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/joaopaulocorreia/element_component
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -42,15 +37,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 4.0.6
 specification_version: 4
-summary: Element Component
+summary: HTML Builder
 test_files: []

data/Gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in element_component.gemspec
-gemspec
-
-gem 'debug'
-gem 'rake', '~> 13.0'
-gem 'rspec', '~> 3.0'
-gem 'rubocop'

data/Gemfile.lock

@@ -1,65 +0,0 @@
-PATH
-  remote: .
-  specs:
-    element_component (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    debug (1.5.0)
-      irb (>= 1.3.6)
-      reline (>= 0.2.7)
-    diff-lcs (1.5.0)
-    io-console (0.5.11)
-    irb (1.4.1)
-      reline (>= 0.3.0)
-    parallel (1.22.1)
-    parser (3.1.2.0)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.3.1)
-    reline (0.3.1)
-      io-console (~> 0.5)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.28.2)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
-
-PLATFORMS
-  ruby
-  x86_64-linux
-
-DEPENDENCIES
-  debug
-  element_component!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop
-
-BUNDLED WITH
-   2.1.2

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'element_component'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/element_component/core/element.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-module El
-  # represent the element base
-  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

data/lib/element_component/core/maker.rb

@@ -1,9 +0,0 @@
-module El
-  class Maker
-    def method_missing(method, **args, &block)
-      new_element = El::Element.new(method.to_s.gsub('_', '-'), **args)
-      block.call new_element if block_given?
-      new_element
-    end
-  end
-end