tuna_roll 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92bd693112f16c935082bd8d1a05e6000375d378a1e3aa2056f27ef8a1c11582
+  data.tar.gz: 199032cf8f1623516eb927a0b944026b336bfbb3182d8b8a0e58912332eec9ee
+SHA512:
+  metadata.gz: 0b2b45501e83685519779d085f032328cd80aba8c430a82de3d6b96483172fdab341caa417a979ae25659e7a3cfbb0ca79f690f975137ff226cdbeeea50349b8
+  data.tar.gz: d1da9a0555a5dba2fe07968a2dcd4bfcfca974c2bc47fb287b6007cb71e3fcad8dc23ae2ad9aa14bce0e7c59a606a564fa3c6ab9bb8241bc1ca47bb11c0de73b

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Danielle Smith
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# TunaRoll
+
+Find all the HTML classes used in your templates. Super-duper experimental, only works on Slim and ERB (although any Temple engine can be adapted), and only find classes statically in the templates themselves.
+
+It works by rendering the template without any Ruby code (so it renders every possible branch) and just extracts all the class attributes. Yeah I know it's really dumb, but anything smarter would be a ridiculous amount of effort.
+
+If it detects any classes with a dynamic portion, it just replaces that portion with the string `%DYNAMIC%`.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add tuna_roll
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install tuna_roll
+```
+
+## Usage
+
+```
+$ tunarall app/views/**/*.erb
+```
+
+Outputs all the classes to stdout. Can take a few seconds if your app is large.
+
+Internally it's just calling `TunaRoll::ClassUnroller.new(path).call` on every file.
+
+###
+
+## Why is it called TunaRoll?
+
+Because it unrolls templates into flat HTML to get all the classes, so template-unroll -> tunroll -> TunaRoll.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/danini-the-panini/tuna_roll.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/exe/tunaroll

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "tuna_roll"
+
+classes = TunaRoll.unroll_classes(*ARGV)
+classes.each { puts it }

data/lib/tuna_roll/class_unroller.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+require_relative "engines/erb_engine"
+require_relative "engines/slim_engine"
+
+module TunaRoll
+  class ClassUnroller
+
+    def initialize(path)
+      @path = path
+    end
+
+    def call
+      html = engine.call(File.read(@path))
+      doc = Nokogiri::HTML(html)
+      doc.css('[class]').flat_map { it.attr('class').split(/\s+/) }.uniq.sort
+    end
+
+    private
+
+      def engine
+        ext = File.extname(@path)
+        case ext
+        when '.erb' then ERBEngine.new
+        when '.slim' then SlimEngine.new
+        when '.html' then :itself.to_proc
+        else warn "unrecognised file extension '#{ext}'"
+        end
+      end
+
+  end
+end

data/lib/tuna_roll/engines/erb_engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "temple"
+require "temple/erb/engine"
+
+require_relative "../generators/static_generator"
+
+module TunaRoll
+  class ERBEngine < Temple::ERB::Engine
+    remove :ArrayBuffer # generator
+    use StaticGenerator
+  end
+end

data/lib/tuna_roll/engines/slim_engine.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "slim"
+
+require_relative "../generators/static_generator"
+
+module TunaRoll
+  class SlimEngine < Slim::Engine
+    remove :Generator
+    use StaticGenerator
+  end
+end

data/lib/tuna_roll/generators/static_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "temple"
+
+module TunaRoll
+  class StaticGenerator < Temple::Generator
+    def save_buffer = nil
+    def restore_buffer = nil
+    def return_buffer = nil
+
+    def on_multi(*exp) = exp.map { compile(it) }.join
+    def on_newline = nil
+    def on_capture(*) = nil
+    def on_static(text) = text
+    def on_dynamic(*) = '%DYNAMIC%'
+    def on_code(*) = nil
+  end
+end

data/lib/tuna_roll/version.rb

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

data/lib/tuna_roll.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "progress"
+
+require_relative "tuna_roll/version"
+require_relative "tuna_roll/class_unroller"
+
+module TunaRoll
+  class Error < StandardError; end
+
+  def self.unroll_classes(*paths)
+    paths.each.with_progress.reduce([]) { |classes, path|
+      classes | ClassUnroller.new(path).call
+    }.sort
+  end
+end

data/sig/tuna_roll.rbs

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

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: tuna_roll
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danielle Smith
+bindir: exe
+cert_chain: []
+date: 2025-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: temple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: progress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: Find all the HTML classes used in your templates. Super-duper experimental,
+  only works on Slim and ERB (although any Temple engine can be adapted), and only
+  find classes statically in the templates themselves.
+email:
+- danielle.smith@platform45.com
+executables:
+- tunaroll
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/tunaroll
+- lib/tuna_roll.rb
+- lib/tuna_roll/class_unroller.rb
+- lib/tuna_roll/engines/erb_engine.rb
+- lib/tuna_roll/engines/slim_engine.rb
+- lib/tuna_roll/generators/static_generator.rb
+- lib/tuna_roll/version.rb
+- sig/tuna_roll.rbs
+homepage: https://github.com/danini-the-panini/tuna_roll
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/danini-the-panini/tuna_roll
+  source_code_uri: https://github.com/danini-the-panini/tuna_roll
+  changelog_uri: https://github.com/danini-the-panini/tuna_roll/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Find all the HTML classes used in your templates.
+test_files: []