custom_tag 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a80dd1476c2c27655a8b83566e873e01f6b210b1572b2b72e323aa50efc68f2
-  data.tar.gz: ed27c8f2294f0ce99e1bea9527eae578b43a505fd7566d3002b8ba3fce2cbff5
+  metadata.gz: 0dfccbf62198fd61a1e7ea003c67c1ceb3391581993e0c5005e205e1c5b2c165
+  data.tar.gz: 19606024d58651af802af5e588b34517c690c862cd394dba8046265a043b5e33
 SHA512:
-  metadata.gz: 9d60a8b0e424a715b079df274982a35bf0db7adf6893cd86938455e90e815f53c6d3af2d5eac9065f9e7c727c4c2af67ed48060fa73e275385b5ed144fac1fba
-  data.tar.gz: e14cb994cf2d986aef92b5b52824eafa195dfea5d966d43ed134a53c941a212a49e890c3ddec5501d297d323892fb538e30d0a6ed2855e257a27ce7d25476198
+  metadata.gz: 554eb2aaa0f13e077e0309a9268a7bf80165473a24c36a4784b9fbf6659644c11d7ea08ee2ec77215765c5766be66f069c5f644389029f01ce226ad6e784f44a
+  data.tar.gz: 33ef60f7c42ca57dec42022e2fda73d4e545574964a23ee86e70653dc307e378a00658f6b6b06a22fb041f3d729ff68c76cf7c735a2934fd05ee86efdbdc00a8

data/.rubocop.yml

@@ -0,0 +1,338 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'script/**/*'
+    - 'node_modules/**/*'
+    - 'doc/**/*'
+    - 'bin/**/*'
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'app/views/sitemap/index.xml.builder'
+    - 'Guardfile'
+    - 'spec/**/*.rb'
+    - vendor/bundle/**/*
+Performance:
+  Exclude:
+    - 'spec/**/*'
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+Style/FetchEnvVar:
+  Enabled: false
+Style/StringChars:
+  Enabled: false
+Naming/BlockForwarding:
+  EnforcedStyle: explicit
+Metrics/ClassLength:
+  Enabled: false
+Naming/MethodParameterName:
+  Enabled: false
+Lint/SuppressedException:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Layout/HashAlignment:
+  Enabled: false
+Layout/ArgumentAlignment:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Bundler/OrderedGems:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+Layout/SpaceBeforeSemicolon:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Lint/RescueException:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: false
+
+Layout/ClosingHeredocIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+  EnforcedShorthandSyntax: never
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+
+Style/RescueModifier:
+  Enabled: false
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: false
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeComment:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/RedundantFreeze:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyleForEmptyBraces: space
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/HashLikeCase:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Empty lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+Lint/AmbiguousOperator:
+  Enabled: true
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+
+Lint/ErbNewArguments:
+  Enabled: true
+
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: false
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Style/GuardClause:
+  Enabled: false
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantBegin:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/TrivialAccessors:
+  Enabled: true
+
+Style/BarePercentLiterals:
+  Enabled: false
+
+Performance/FlatMap:
+  Enabled: true
+
+Performance/RedundantMerge:
+  Enabled: true
+
+Performance/StartWith:
+  Enabled: true
+
+Performance/EndWith:
+  Enabled: true
+
+Performance/RegexpMatch:
+  Enabled: true
+
+Performance/ReverseEach:
+  Enabled: true
+
+Performance/UnfreezeString:
+  Enabled: true
+
+Style/IfInsideElse:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false

data/.standard.yml

@@ -1,3 +1,7 @@
 # For available configuration options, see:
 #   https://github.com/testdouble/standard
 ruby_version: 2.6
+ignore:
+  - '**/*':
+    - Style/StringLiterals
+    - Metrics/AbcSize

data/CHANGELOG.md

@@ -1 +1,9 @@
 # CHANGELOG for CustomTag
+
+## 0.2.0 - 9 July 2023
+
+Rack middleware implemented and documentation written.
+
+## 0.1.0 - 3 July 2023
+
+Basics of this gem working, need to implement the Rack middleware, but the core replacement code is working.

data/Gemfile

@@ -9,4 +9,7 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 
-gem "standard", "~> 1.3"
+gem "rubocop"
+gem "rubocop-performance"
+
+gem "rack"

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    custom_tag (0.2.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    nokogiri (1.15.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.2-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rack (3.0.8)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.52.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  custom_tag!
+  rack
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+
+BUNDLED WITH
+   2.4.6

data/README.md

@@ -1,6 +1,83 @@
 # CustomTag
 
-> CustomTag allows you to use custom HTML tags in your Rails project and have them be replaced with standard HTML tags and attributes.
+> CustomTag allows you to use custom HTML tags in your Rails project and have them be replaced with standard HTML tags and attributes. Brought on by jealousy of extracting TailwindCSS classes to simple components in frontend frameworks.
+
+## Usage
+
+This gem allows you write custom HTML tags in your HTML output and have them replaced with other tags. For example you could do the following:
+
+```html
+<my-card>
+  <h3>Your name here</h3>
+  <div>Job title</div>
+</my-card>
+```
+
+And it can be replaced with:
+
+```html
+<div class="p-4 bg-white border border-gray-200 shadow-lg">
+  <h3>Your name here</h3>
+  <div>Job title</div>
+</div>
+```
+
+This keeps your TailwindCSS classes from being repeated all over your codebase, while not using `@apply` (<https://tailwindcss.com/docs/reusing-styles>). It's a middleground between full template systems like [Phlex](https://github.com/phlex-ruby/phlex) and [ViewComponent](https://viewcomponent.org) and just having lists of classes everywhere.
+
+### Defining your tags
+
+To define your tags is nice and easy. Have one or more classes that are loaded early (maybe in `config/initializers` in Rails, or directly required if you're using Sinatra or some other lightweight framework) that define the tags you're creating, and how to replace the matching content with HTML. For example, to define a class that performs a single replacement, you could do:
+
+```ruby
+class MyCard < CustomTag::Base
+  register :my_card, self
+
+  def self.build(_, attrs, content)
+    attrs["class"] = "p-4 bg-white border border-gray-200 shadow-lg #{attrs["class"]}".strip
+    super("div", attrs, content)
+    # The super will simply build an HTML tag from the details given
+  end
+end
+```
+
+You can call the `register` method with any of `under_scored`, `hyphen-ated` or `CamelCased` tags names and it will automatically convert between them to accept any one of them as the same thing.
+
+If you wish you can have multiple tags defined in a single class and use the first parameters of `build` to distinguish between them:
+
+```ruby
+class ApplicationCustomTags < CustomTag::Base
+  register :my_card, self
+
+  def self.build(tag_name, attrs, content)
+    case tag_name
+    when "my_card"
+      my_card(attrs, content)
+    when "..."
+      # ...
+    end
+  end
+
+  def self.my_card(attrs,content)
+    attrs["class"] = "p-4 bg-white border border-gray-200 shadow-lg #{attrs["class"]}".strip
+    "<div #{attrs.map { |k, v| "#{k}=\"#{v}\"" }.join(" ")}>#{content}</div>"
+  end
+end
+```
+
+### Middleware
+
+If you're using Rails, the CustomTag Middleware will be automatically registered for you as the last middleware to be called. If you want to use it yourself in a non-Rails app, you can use it like this:
+
+```ruby
+require 'sinatra'
+require 'custom_tag'
+
+use CustomTag::Middleware
+
+get '/hello' do
+  '<some HTML here... />'
+end
+```
 
 ## Installation
 
@@ -8,19 +85,19 @@ Install the gem and add to the application's Gemfile by executing:
 
     bundle add custom_tag
 
+Or adding `gem "custom_tag"` to your `Gemfile` and running `bundle install`.
+
 If bundler is not being used to manage dependencies, install the gem by executing:
 
     gem install custom_tag
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec 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 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).
+To release a new version, update the version number in `version.rb`, edit the `CHANGELOG.md` file to explain the new release 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).
 
 ## Contributing
 

data/Rakefile

@@ -5,6 +5,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "standard/rake"
-
-task default: %i[spec standard]
+task default: %i[spec rubocop]

data/custom_tag.gemspec

@@ -30,9 +30,9 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "nokogiri"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/custom_tag/base.rb

@@ -0,0 +1,42 @@
+module CustomTag
+  class Base
+    @@tags = {}
+
+    def self.register(tag_name, klass)
+      @@tags[tag_name.to_s] = klass
+      @@tags[tag_name.to_s.gsub(/([A-Z])/) { |m| "_#{m.downcase}" }] = klass
+      @@tags[tag_name.to_s.gsub(/([A-Z])/) { |m| "-#{m.downcase}" }] = klass
+      @@tags[tag_name.to_s.tr("_", "-").downcase] = klass
+      @@tags[tag_name.to_s.gsub(/_([a-z])/) { |m| m[1].upcase }] = klass
+      @@tags[tag_name.to_s.tr("-", "_").downcase] = klass
+      @@tags[tag_name.to_s.gsub(/-([a-z])/) { |m| m[1].upcase }] = klass
+      @@tags[tag_name.to_s.delete("-").downcase] = klass
+      @@tags[tag_name.to_s.delete("_").downcase] = klass
+      @@tags[tag_name.to_s.downcase] = klass
+    end
+
+    def self.tags
+      @@tags
+    end
+
+    def self.replace(tag_name, attrs, content)
+      ret = if @@tags[tag_name]
+        @@tags[tag_name].build(tag_name, attrs, content)
+      else
+        build(tag_name, attrs, content)
+      end
+
+      doc = Nokogiri::XML.fragment(ret)
+      doc.search("*").each do |element|
+        if CustomTag::Base.tags[element.name]
+          element.replace(CustomTag::Base.replace(element.name, element.attributes, element.content))
+        end
+      end
+      doc.to_html.strip
+    end
+
+    def self.build(tag_name, attrs, content)
+      "<#{tag_name} #{attrs.map { |k, v| "#{k}=\"#{v}\"" }.join(" ")}>#{content}</#{tag_name}>"
+    end
+  end
+end

data/lib/custom_tag/middleware.rb

@@ -0,0 +1,15 @@
+module CustomTag
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      code, headers, response = @app.call(env)
+
+      response[0] = CustomTag.parse_and_replace(response[0]) if headers["Content-Type"]&.include?("text/html")
+
+      [code, headers, response]
+    end
+  end
+end

data/lib/custom_tag/railties.rb

@@ -0,0 +1,9 @@
+if defined?(Rails::Railtie)
+  module CustomTag
+    class Railtie < Rails::Railtie
+      initializer do |app|
+        app.middleware.use Middleware
+      end
+    end
+  end
+end

data/lib/custom_tag/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CustomTag
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/custom_tag.rb

@@ -1,8 +1,21 @@
 # frozen_string_literal: true
 
+require "nokogiri"
 require_relative "custom_tag/version"
+require_relative "custom_tag/base"
+require_relative "custom_tag/middleware"
+require_relative "custom_tag/railties"
 
 module CustomTag
   class Error < StandardError; end
-  # Your code goes here...
+
+  def self.parse_and_replace(content)
+    doc = Nokogiri::HTML.parse(content)
+    doc.search("*").each do |element|
+      if CustomTag::Base.tags[element.name]
+        element.replace(CustomTag::Base.replace(element.name, element.attributes, element.children.to_html))
+      end
+    end
+    doc.to_html(save_with: 0)
+  end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: custom_tag
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-07 00:00:00.000000000 Z
-dependencies: []
+date: 2023-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Jealous of custom <tags> in JS frameworks and want them in your Rails
   apps? CustomTag allows you to use custom HTML tags in your Rails project and have
   them be replaced with standard HTML tags and attributes.
@@ -20,13 +34,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".rubocop.yml"
 - ".standard.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - custom_tag.gemspec
 - lib/custom_tag.rb
+- lib/custom_tag/base.rb
+- lib/custom_tag/middleware.rb
+- lib/custom_tag/railties.rb
 - lib/custom_tag/version.rb
 - sig/custom_tag.rbs
 homepage: https://github.com/andyjeffries/customtag
@@ -35,6 +54,7 @@ metadata:
   homepage_uri: https://github.com/andyjeffries/customtag
   source_code_uri: https://github.com/andyjeffries/customtag
   changelog_uri: https://github.com/andyjeffries/customtag/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: