windclutter 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d78ffb00f209ad02661a3f89becd27529bee951d4771d0c7652d812c42d2fae4
-  data.tar.gz: 5f275b60efc0ecd44dcc1dd17611458843f8dc6184165b339605517f249cb285
+  metadata.gz: e8069052276a087b367d01c2fee3032f5f7d9a6a9cbcaa0dda55e2ea19894305
+  data.tar.gz: b461fbcca0426f7e6b2928428259213d90189d17b33146cd669c06ae65308e42
 SHA512:
-  metadata.gz: a9af647e24a8c8be2670da0cebd5ef366b6d14ad10e36be1fa561af0ef202c925ad62adae3215f939078ab25eeea2365b84034ed8aa38e52406385e465652f97
-  data.tar.gz: 9067f02ef95187d804e34b12f89863b4f04d3cd080c2a4b17c4aa2364c9fe568b72a40292fd7178bfd01b888ab7d335c90d13500438839d5331533ea319dfb70
+  metadata.gz: 39a82623e50cbc57c4d6aaaf245f1160b3132f5e93114682bc8b6dcbda39044887cac969ea161ac8163458304da7f42645903840a987c72e7f50c67cdff65dcd
+  data.tar.gz: 824112979e6a312c8ef64bd3c696a77686af174466e4e3fd463a08992d7d7974c548b437269a177967e94f8ed533d8237a680bd42009bd3bd9ea147fd4098118

data/README.md

@@ -1,64 +1,95 @@
-![Test Badge](https://github.com/Xavier-iV/windclutter/actions/workflows/main.yml/badge.svg)
+![Test Badge](https://github.com/Xavier-iV/windclutter/actions/workflows/main.yml/badge.svg) [![Gem Version](https://badge.fury.io/rb/windclutter.svg)](https://badge.fury.io/rb/windclutter)
 
-## WindClutter
+<div align="center">
+  <h1>WindClutter</h1>
+  <p>De-cluttering your TailwindCSS.</p>
+</div>
+
+<p align="center">
+  <a href="https://github.com/Xavier-IV/windclutter/wiki">Wiki</a>
+  ·
+  <a href="https://github.com/Xavier-IV/windclutter/wiki/Developer">Developer's Guide</a>
+  <br>
+  <br>
+</p>
+
+<hr/>
+
+## Overview
+
+You created awesome project.
+
+&nbsp;&nbsp;&nbsp;&nbsp;It's completed.
 
-You created awesome project, it's completed, your users are happy. But now you are left with this question:
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Your users are happy. 
 
-> What am I going to do with this TailwindCSS class clutter?
+But now you are left with this question:
 
-You know what I'm talking about.
+> All this TailwindCSS clutter...what should I do with it?
+
+You know what I'm talking about. Due to rapid development, we prefer to put Tailwind classes directly into your divs.
+
+As time goes, this clutter grows.
 
 This tool aim to:
 
 - Provide analysis of your project
 - Identify common uses of Tailwind class
-- Cleanup for large ejected project
+- Cleanup for large projects
+
+Once your project grows and ready for your users, chances are you are left with
+humongous task of Tailwind CSS cleanup.
+
+**Roadmap progress**
+
+- [x] Project identification/init
+- [x] Single file analysis
+- [ ] User own class exclusion (if specified)
+- [ ] Single file de-cluttering
+- [ ] Full project analysis
+- [ ] Full project auto de-clutter
 
-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.
+<hr/>
 
 ## Installation
 
 ```bash
 # requires ruby 2.7 and above
 $ gem install windclutter
+
+$ windclutter install
 ```
 
 ## In Action
 
-```html
-<div class="my-class border rounded-md px-4 py-2 bg-primary-100">
-    <!-- -->
-</div>
 ```
+$ cd your_project
 
-What if we can help you, if not a bit?
+$ windclutter project use <your_project_name>
+$ windclutter analysis file src/index.html
+```
 
 ```html
-<div class="my-class adkuioqa">
+<div class="my-class border rounded-md px-4 py-2 bg-primary-100">
     <!-- -->
 </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>
+# output
+{"my-class"=>1, "border"=>1, "rounded-md"=>1, "px-4"=>1, "py-2"=>1, "bg-primary-100"=>1}
 ```
 
-## Concept
+## Bleeding Edge!
 
-This is currently in ideation, but me myself are eagerly waiting to try this myself.
+This is currently in ideation, but I can't wait to try this even myself.
 
-I have a lot of codebases that needs cleanup! 🤯
+I have a lot of TailwindCSS project that needs cleanup 🤯
 
 ## Contributing
 
 Take a look into:
-https://github.com/Xavier-IV/windclutter/wiki/Developer
+https://github.com/Xavier-IV/windclutter/wiki
 
 
 ## Great alternative

data/lib/windclutter/analyser.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
+require 'windclutter/util/collector'
 require 'windclutter/util/config'
+require 'windclutter/util/sorter'
+require 'windclutter/util/file_handler'
 
 module WindClutter
   # Analyser for windclutter
@@ -21,12 +24,22 @@ module WindClutter
       content.scan(regex).each do |occurrence|
         cls = occurrence.to_s.match(occurrence_regex)[1].split(' ')
 
-        cls.each do |c|
-          total = collections[c].nil? ? 0 : collections[c]
-          collections[c] = total + 1
-        end
+        cls.each { |k| collect(collections, k, 1) }
       end
-      collections.sort_by { |_, v| -v }.to_h
+      sorter(collections).to_h
+    end
+
+    def self.traverse(suffix, limit)
+      collection = {}
+      scanned = FileHandler.scanners(suffix)
+      scanned.each do |file|
+        init(File.open(file).read).each { |k, v| collect(collection, k, v) }
+      end
+
+      sorted = sorter(collection)
+      result = limit.positive? ? sorted.first(limit).to_h : sorted.to_h
+
+      [sorted.count, result, scanned.count]
     end
   end
 end

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

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+require 'awesome_print'
 require 'dry/cli'
 require 'windclutter/analyser'
 require 'windclutter/util/file_handler'
+require 'windclutter/util/collector'
+require 'windclutter/util/sorter'
 require 'windclutter/cli/commands/project'
 require 'windclutter/cli/commands/generate'
 
@@ -12,17 +15,47 @@ module WindClutter
       module Analysis
         # Initiate setup for specified project
         class FilePath < Dry::CLI::Command
+          include WindClutter
           include WindClutter::Util
 
           desc 'Perform CSS analysis of the path'
-          argument :path, aliases: ['-p'], required: true, desc: 'Path of your CSS file to be dump.'
+          argument :file, aliases: ['-f'], required: true, desc: 'Path of your CSS file to be dump.'
 
-          def call(path:, **)
-            puts "Analysing #{path}...".green
+          def call(file:, **)
+            return puts "No file found #{file}".red unless File.file?(file)
 
-            file = File.open(FileHandler.scan_one(path))
+            puts "Analysing #{file}...".yellow
+
+            content = File.open(FileHandler.scan_one(file))
             puts 'Done!'.green
-            puts WindClutter::Analyser.init(file.read)
+            ap Analyser.init(content.read)
+          end
+        end
+
+        # Perform full traversal analysis
+        class Traverse < Dry::CLI::Command
+          include WindClutter
+          include WindClutter::Util
+
+          desc 'Perform full traversal analysis'
+
+          argument :suffix, aliases: ['-s'], required: true, desc: 'Suffix of all files to be traversed.'
+
+          option :full, type: :boolean, alias: '-f', default: false, desc: 'Print out whole classes.'
+
+          option :collect, type: :integer, alias: '-c', default: 5, desc: 'Specify how many of result to collect.'
+
+          def call(suffix:, **options)
+            full = options.fetch(:full)
+            collect_count = full ? 0 : options.fetch(:collect).to_i
+            puts "Analysing #{suffix}...".yellow
+
+            total, scanned, file_count = Analyser.traverse(suffix, collect_count)
+            puts "Traversed #{file_count} #{suffix} file(s)... 🎉".green
+            ap scanned
+            return unless collect_count.positive? && (total - collect_count).positive?
+
+            puts "...and #{total - collect_count} more".yellow
           end
         end
       end

data/lib/windclutter/cli/core.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'dry/cli'
+require 'rubygems'
+require 'bundler/setup'
 require 'windclutter/util/file_handler'
 require 'windclutter/cli/commands/project'
 require 'windclutter/cli/commands/generate'
@@ -17,7 +19,9 @@ module WindClutter
         desc 'Print version'
 
         def call(*)
-          puts '0.0.1'
+          gemspec = Gem::Specification.load('windclutter.gemspec')
+
+          puts gemspec.version.to_s
         end
       end
 
@@ -70,6 +74,7 @@ module WindClutter
 
       register 'analysis', aliases: %w[a -a] do |prefix|
         prefix.register 'file', Commands::Analysis::FilePath, aliases: ['-p']
+        prefix.register 'traverse', Commands::Analysis::Traverse, aliases: ['-t']
       end
 
       register 'generate', aliases: ['g'] do |prefix|

data/lib/windclutter/util/collector.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+def collect(collection, key, value)
+  collection[key] ||= 0
+  collection[key] = collection[key] + value
+end

data/lib/windclutter/util/file_handler.rb

@@ -46,7 +46,7 @@ module WindClutter
       end
 
       def self.scanners(extension)
-        Dir["#{File.dirname(__FILE__)}/**/*#{extension}"]
+        Dir["#{Dir.pwd}/**/*#{extension}"]
       end
 
       def self.scan_one(path)

data/lib/windclutter/util/sorter.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+def sorter(collection)
+  collection.sort_by { |_, v| -v }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: windclutter
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Zafranudin Zafrin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-07 00:00:00.000000000 Z
+date: 2023-09-08 00:00:00.000000000 Z
 dependencies: []
 description: Your buddy to skyrocket your development with TailwindCSS.
 email: coffee@zafranudin.dev
@@ -28,9 +28,11 @@ files:
 - lib/windclutter/cli/commands/project.rb
 - lib/windclutter/cli/core.rb
 - lib/windclutter/processor.rb
+- lib/windclutter/util/collector.rb
 - lib/windclutter/util/config.rb
 - lib/windclutter/util/file_handler.rb
 - lib/windclutter/util/generator.rb
+- lib/windclutter/util/sorter.rb
 - test/fixtures/config_fixture.rb
 - test/test_windclutter.rb
 - test/windclutter/test_analyser.rb