windclutter 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7228d312e25ff4308cb7e6f753a71d25452c9c1cfde852bbab75f35853f3ff98
+  data.tar.gz: 580a419ed1d91abc97831fc0836e7547c5b1544c6563f5ee4a454181778d6bc6
+SHA512:
+  metadata.gz: 5a54ffa345fbfb0b234126b9e1f304ebdea473e84087ed387c2c555b87549abcdebcc510b83040bccb45f9de28c1f65325bb2984345cbd9b4d1cfe50fa583a3a
+  data.tar.gz: 2b6ea373ca2273fed179ded3e24ee3553b3fd0cb465d7dff8d3b0968b9b5ab73551180c613c70b04b717f3f03c332486115286f6dc072e022a100ff05a9082d9

data/README.md

@@ -0,0 +1,62 @@
+![Test Badge](https://github.com/Xavier-iV/windclutter/actions/workflows/main.yml/badge.svg)
+
+## WindClutter
+
+You created awesome project, it's completed, your users are happy. But now you are left with this question:
+
+> What am I going to do with this TailwindCSS class clutter?
+
+You know what I'm talking about.
+
+This tool aim to:
+
+- Provide analysis of your project
+- Identify common uses of Tailwind class
+- Cleanup for large ejected project
+
+Once your project grows and ready to for your clients, chances are you are left with
+humongous task of Tailwind CSS cleanup. I call this "ejected" states.
+
+## In Action
+
+```html
+<div class="my-class border rounded-md px-4 py-2 bg-primary-100">
+    <!-- -->
+</div>
+```
+
+What if we can help you, if not a bit?
+
+```html
+<div class="my-class adkuioqa">
+    <!-- -->
+</div>
+```
+
+We'll cleanup your html files and organize the CSSes. You can then choose what to name them.
+
+`adkuioqa = .btn`
+```
+<div class="my-class btn">
+    <!-- -->
+</div>
+```
+
+## Concept
+
+This is currently in ideation, but me myself are eagerly waiting to try this myself.
+
+I have a lot of codebases that needs cleanup! 🤯
+
+## Contributing
+
+Take a look into:
+https://github.com/Xavier-IV/windclutter/wiki/Developer
+
+
+## Great alternative
+
+There are some limited alternative that I'm aware of and are still searching:
+
+- [Windi CSS Analyzer](https://windicss.org/features/analyzer.html) (Sunsetting)
+- [Tailwind CSS Analysis](https://github.com/apvarun/tailwindcss-analysis)

data/bin/windclutter

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'dry/cli'
+
+require 'windclutter/cli/core'
+
+Dry::CLI.new(WindClutter::CLI::Commands).call

data/lib/windclutter/analyser.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WindClutter
+  # Analyser for windclutter
+  class Analyser
+  end
+end

data/lib/windclutter/cli/commands/generate.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+require 'windclutter/util/file_handler'
+require 'windclutter/util/config'
+require 'windclutter/util/generator'
+require 'windclutter/processor'
+
+module WindClutter
+  module CLI
+    module Commands
+      module Generate
+        # Initiate setup for specified project
+        class OnFly < Dry::CLI::Command
+          include WindClutter::Util
+
+          desc 'Perform inline generation of class'
+
+          def call(**opt)
+            puts
+            name = Generator.random_class
+
+            classes = WindClutter::Processor.sort(opt[:args])
+            puts WindClutter::Processor.build_single(name, classes)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/windclutter/cli/commands/project.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+require 'windclutter/util/file_handler'
+require 'windclutter/util/config'
+
+module WindClutter
+  module CLI
+    module Commands
+      module Project
+        # Initiate setup for specified project
+        class Init < Dry::CLI::Command
+          include WindClutter::Util
+
+          desc 'Setup windclutter for your project'
+
+          argument :name, required: true, desc: 'Name of your project.'
+
+          def call(name:, **)
+            FileHandler.create_project(name)
+            puts 'Successfully created!'.green
+          end
+        end
+
+        # List all of created project for windclutter
+        class List < Dry::CLI::Command
+          include WindClutter::Util
+
+          desc 'List all of created windclutter project.'
+
+          def call(**)
+            puts FileHandler.list_projects
+          end
+        end
+
+        # Use specified project
+        class Use < Dry::CLI::Command
+          include WindClutter::Util
+
+          desc 'Use the project, automatically create one if not exists yet.'
+
+          argument :name, required: true, desc: 'Name of your project.'
+
+          def call(name:, **)
+            return Config.read('active_project') if name.nil?
+
+            unless FileHandler.list_projects.include? name
+              FileHandler.create_project(name)
+              puts 'No project, we created one instead'.green
+            end
+
+            Config.update('active_project', name)
+            puts "Using project \"#{name}\"".green
+          end
+        end
+      end
+    end
+  end
+end

data/lib/windclutter/cli/core.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+require 'windclutter/util/file_handler'
+require 'windclutter/cli/commands/project'
+require 'windclutter/cli/commands/generate'
+
+module WindClutter
+  module CLI
+    # Command module to be use by CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      # Print out the version of windclutter
+      class Version < Dry::CLI::Command
+        desc 'Print version'
+
+        def call(*)
+          puts '0.0.1'
+        end
+      end
+
+      # Perform initial setup for windclutter
+      class Install < Dry::CLI::Command
+        include WindClutter::Util
+
+        desc 'Initiate first setup for tail_draft'
+
+        def call(*)
+          FileHandler.init_config
+        end
+      end
+
+      # Uninstallation handler
+      class Uninstall < Dry::CLI::Command
+        include WindClutter::Util
+
+        desc 'Remove all windclutter setup and configurations'
+
+        def call(*)
+          FileHandler.uninstall
+        end
+      end
+
+      register 'version', Version, aliases: %w[v -v --version]
+      register 'install', Install, aliases: %w[i -i --install]
+      register 'uninstall', Uninstall, aliases: %w[u -u --uninstall]
+
+      register 'project', aliases: ['p'] do |prefix|
+        prefix.register 'init', Commands::Project::Init
+        prefix.register 'list', Commands::Project::List
+        prefix.register 'use', Commands::Project::Use
+      end
+
+      register 'generate', aliases: ['g'] do |prefix|
+        prefix.register 'on-fly', Commands::Generate::OnFly
+      end
+    end
+  end
+end

data/lib/windclutter/processor.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'windclutter/util/generator'
+
+module WindClutter
+  # Processor for windclutter
+  class Processor
+    include WindClutter::Util
+
+    def initialize
+      @key_tag = :windclutter
+    end
+
+    def self.build_single(name, classes)
+      <<~OUTPUT
+        .#{name} {
+          @apply #{classes.join(' ')};
+        }
+      OUTPUT
+    end
+
+    def self.auto_process(file_content, collections)
+      return if file_content.nil?
+
+      regex = /class="(?:(?!#{@key_tag}:)[^"])*"/
+      class_occurrences = file_content.scan(regex)
+
+      class_occurrences.each do |occurrence|
+        gen_class = Generator.random_class
+        file_content = file_content.gsub(/#{occurrence}/, "class=\"#{gen_class}\"")
+
+        collections.push({
+                           generated_name: gen_class,
+                           provided_name: nil,
+                           class: occurrence.to_s.match(/class="([^"]*)"/)[1],
+                           named: false
+                         })
+      end
+      file_content
+    end
+
+    def self.sort(classes)
+      classes.sort
+    end
+  end
+end

data/lib/windclutter/util/config.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'colorize'
+require 'yaml'
+
+module WindClutter
+  module Util
+    # Config handler
+    class Config
+      def self.update(key, value)
+        return unless config_exists?
+
+        config = YAML.load_file('/tmp/windclutter/config.yml')
+        config[key] = value
+
+        File.open('/tmp/windclutter/config.yml', 'w') { |f| YAML.dump(config, f) }
+      end
+
+      def self.read(key)
+        return unless config_exists?
+
+        config = YAML.load_file('/tmp/windclutter/config.yml')
+        config[key]
+      end
+
+      def self.config_exists?
+        unless File.file?('/tmp/windclutter/config.yml')
+          puts 'You have not install windclutter yet'.yellow
+          puts 'To install, run:'
+          puts "\twindclutter install".green
+          return false
+        end
+        true
+      end
+    end
+  end
+end

data/lib/windclutter/util/file_handler.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'colorize'
+require 'yaml'
+
+module WindClutter
+  module Util
+    # Generator helper
+    class FileHandler
+      def self.init_config
+        FileUtils.mkdir_p('/tmp/windclutter')
+
+        return puts 'Setup already performed!'.yellow if File.file?('/tmp/windclutter/config.yml')
+
+        template = File.expand_path('../../template', File.dirname(__FILE__))
+
+        puts 'Created the following files:'
+        Dir["#{template}/*.yml"].each do |t|
+          FileUtils.cp(t, '/tmp/windclutter')
+          puts "\t#{t}"
+        end
+
+        puts "\nSetup completed!".green
+      end
+
+      def self.uninstall
+        Dir['/tmp/windclutter'].each do |t|
+          FileUtils.rm_rf(t)
+        end
+
+        puts 'Uninstall completed!'.green
+      end
+
+      def self.create_project(value)
+        FileUtils.mkdir_p("/tmp/windclutter/projects/#{value}")
+      end
+
+      def self.list_projects
+        Dir['/tmp/windclutter/projects/*'].map do |t|
+          t.split('/tmp/windclutter/projects/')[1]
+        end
+      end
+
+      def self.scanners(extension)
+        Dir["#{File.dirname(__FILE__)}/**/*#{extension}"]
+      end
+
+      def self.overwrite(file, content)
+        File.open(file, 'w') { |t| t.puts content }
+      end
+    end
+  end
+end

data/lib/windclutter/util/generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WindClutter
+  module Util
+    # Generator helper
+    class Generator
+      def self.random_class(prefixed: true)
+        random = [*'A'..'Z'].sample(10).join.downcase
+        "windclutter:#{random}" if prefixed
+        random
+      end
+    end
+  end
+end

data/lib/windclutter.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'windclutter/processor'
+require 'windclutter/cli'

data/test/test_windclutter.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+
+Dir['test/windclutter/**/*.rb'].sort.each { |f| require f.split('/')[1..].join('/') }

data/test/windclutter/test_processor.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'windclutter/processor'
+
+class WindClutterProcessorTest < Minitest::Test
+  def test_able_to_generate_block
+    result = WindClutter::Processor.build_single('class', %w[container mx-auto])
+
+    assert_equal ".class {\n  @apply container mx-auto;\n}\n",
+                 result
+  end
+
+  def test_able_to_auto_process
+    WindClutter::Util::Generator.stub(:random_class, 'windclutter:mocked_value') do
+      collections = []
+      result = WindClutter::Processor.auto_process(dummy_content, collections)
+
+      assert_equal result, expected_output
+      assert_equal collections[0][:generated_name], 'windclutter:mocked_value'
+      assert_equal collections[0][:class], 'flex flex-col items-center gap-6 px-10 py-40 overflow-y-scroll'
+      assert_nil collections[0][:provided_name]
+      assert_equal collections[0][:named], false
+    end
+  end
+
+  private
+
+  def dummy_content
+    <<~CONTENT
+      <div class="flex flex-col items-center gap-6 px-10 py-40 overflow-y-scroll">
+      </div>
+    CONTENT
+  end
+
+  def expected_output
+    <<~CONTENT
+      <div class=\"windclutter:mocked_value\">
+      </div>
+    CONTENT
+  end
+
+  def expected_collections
+    { generated_name: 'windclutter:mocked_value',
+      class: 'flex flex-col items-center gap-6 px-10 py-40 overflow-y-scroll' }
+  end
+end

data/test/windclutter/util/test_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'windclutter/util/generator'
+
+class WindClutterUtilGeneratorTest < Minitest::Test
+  def test_able_to_randomize_class_name
+    assert_match(/.[a-z]+/,
+                 WindClutter::Util::Generator.random_class)
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: windclutter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Zafranudin Zafrin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-06 00:00:00.000000000 Z
+dependencies: []
+description: Your buddy to skyrocket your development with TailwindCSS.
+email: coffee@zafranudin.dev
+executables:
+- windclutter
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/windclutter
+- lib/windclutter.rb
+- lib/windclutter/analyser.rb
+- lib/windclutter/cli/commands/generate.rb
+- lib/windclutter/cli/commands/project.rb
+- lib/windclutter/cli/core.rb
+- lib/windclutter/processor.rb
+- lib/windclutter/util/config.rb
+- lib/windclutter/util/file_handler.rb
+- lib/windclutter/util/generator.rb
+- test/test_windclutter.rb
+- test/windclutter/test_processor.rb
+- test/windclutter/util/test_generator.rb
+homepage: https://rubygems.org/gems/tailwind_buddy
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.18
+signing_key:
+specification_version: 4
+summary: Quickly develop with TailwindCSS without worries.
+test_files: []