miss-marple 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2fb606a3e03eb00447fe26f98469b1f898e75b2
+  data.tar.gz: 8550af14218076fa7a90ca3a6f989302df396e1d
+SHA512:
+  metadata.gz: 7dcb7619c0039ea5d46ac372c100c22e399dc71524e0728b67675bfbc47316e997ffa83b3ff9132258d0a8a7beed1115a5c5023af65afc022578bf91cbee0efc
+  data.tar.gz: 1eabf544cb0b0dca736bf3a028742187ec57078782739d9f6a4f84e77ac6fe9e0f115379b085cf3e170926faf93fc5c277a75b88554564c8ba064d0a77df5c19

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.1
+script: rake test

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sweeper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jana Petrova
+
+MIT License
+
+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,33 @@
+# Miss Marple
+[![Coverage Status](https://coveralls.io/repos/JanaVPetrova/miss-marple/badge.png?branch=develop)](https://coveralls.io/r/JanaVPetrova/miss-marple?branch=develop)
+[![Build Status](https://travis-ci.org/JanaVPetrova/miss-marple.png?branch=develop)](https://travis-ci.org/JanaVPetrova/miss-marple)
+
+
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'miss-marple'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install miss-marple
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/JanaVPetrova/miss-marple/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib", "test"
+  t.test_files = FileList["test/miss-marple/*_test.rb"]
+  t.verbose = false
+end
+
+task :default => [:test]

data/bin/miss-marple

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+require 'miss-marple'
+
+MissMarple::Detector.run "**/**"

data/lib/miss-marple/comparer.rb

@@ -0,0 +1,17 @@
+class MissMarple::Comparer
+  def self.compare(parsed, searched)
+    searched.map!{|fname| fname.split(".").first }
+
+    searched.reject{ |fname| search_similar(parsed, fname) }
+  end
+
+  private
+  def self.search_similar(arr, searched_fname)
+    arr.each do |path|
+      if searched_fname.end_with?(path) || searched_fname.start_with?(path)
+        return true
+      end
+    end
+    return false
+  end
+end

data/lib/miss-marple/detector.rb

@@ -0,0 +1,19 @@
+class MissMarple::Detector
+  def self.run(rails_root)
+    dirs = ["app/assets", "lib/assets", "vendor/assets"]
+    dirs.map!{|path| rails_root + path}
+
+    searched = MissMarple::Searcher.search(dirs)
+
+    required = searched.inject([]){ |result, fname| result + MissMarple::Parser.parse(fname) }
+
+    # FIXME insert requiring into required. this is not a place for logic %)
+    # FIXME dirty hack
+    requiring = searched.reject(){ |fname| MissMarple::Parser.parse(fname).empty? }
+    searched -= requiring
+
+    unused = MissMarple::Comparer.compare(required, searched)
+
+    MissMarple::Logger.log(unused, requiring)
+  end
+end

data/lib/miss-marple/logger.rb

@@ -0,0 +1,13 @@
+class MissMarple::Logger
+  def self.log(unused, requiring)
+    if unused.empty?
+      puts "No unused assets!"
+    else
+      puts "Unused assets:"
+      puts unused
+      puts
+      puts "Requiring files: "
+      puts requiring
+    end
+  end
+end

data/lib/miss-marple/parser.rb

@@ -0,0 +1,18 @@
+class MissMarple::Parser
+  def self.parse(path)
+    content = File.readlines(path)
+    valuable_strings = content.reject{ |str| !str.include?("= require") }
+
+    required = search_paths valuable_strings, path
+    required += valuable_strings.map{ |str| str.partition("require ").last.chomp }
+    required.map!{|str| str.gsub(".", "")}
+    required.reject{ |str| str.empty? }
+  end
+
+  private
+  def self.search_paths arr, path
+    result = arr.map{ |str| str.partition("require_tree ").last.chomp }
+    result.reject!{ |str| str.empty? }
+    result.map{|str| File.dirname(path) + str }
+  end
+end

data/lib/miss-marple/searcher.rb

@@ -0,0 +1,10 @@
+class MissMarple::Searcher
+  def self.search(paths)
+    files_and_dirs = paths.map{|path| Dir.glob("#{path}/**/*") }.flatten
+
+    permited_exts = %(.css .js .js.coffee .less .scss .sass)
+
+    no_dirs = files_and_dirs.reject{ |file| File.directory?(file) }
+    no_dirs.reject{|file| !permited_exts.include? File.extname(file) }
+  end
+end

data/lib/miss-marple/version.rb

@@ -0,0 +1,3 @@
+module MissMarple
+  VERSION = "0.0.1"
+end

data/lib/miss-marple.rb

@@ -0,0 +1,9 @@
+require "miss-marple/version"
+
+module MissMarple
+  autoload :Parser, "miss-marple/parser"
+  autoload :Comparer, "miss-marple/comparer"
+  autoload :Searcher, "miss-marple/searcher"
+  autoload :Detector, "miss-marple/detector"
+  autoload :Logger, "miss-marple/logger"
+end

data/miss-marple.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'miss-marple/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "miss-marple"
+  spec.version       = MissMarple::VERSION
+  spec.authors       = ["Jana Petrova"]
+  spec.email         = ["janavpetrova@gmail.com"]
+  spec.summary       = "Detects unused assets"
+  spec.description   = "Miss Marple provides an easy way to detect unused assets"
+  spec.homepage      = "https://github.com/JanaVPetrova/miss-marple"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "minitest", "~> 4.2"
+  spec.add_development_dependency "wrong", "~> 0.7"
+  spec.add_development_dependency "coveralls", "~> 0.7"
+end

data/test/fixtures/app.css

@@ -0,0 +1,4 @@
+/*
+ *= require ui/orange
+ *= require style
+ */

data/test/fixtures/tree/manifest.css

@@ -0,0 +1,3 @@
+/*
+ *= require_tree .
+ */

data/test/miss-marple/comparer_test.rb

@@ -0,0 +1,15 @@
+require "test_helper"
+
+class MissMarple::ComparerTest < MiniTest::Unit::TestCase
+  def setup
+    @parsed_filenames = ["ui/orange", "app"]
+    @searched_filenames = @parsed_filenames + ["extra-file"]
+
+    @compared = MissMarple::Comparer.compare(@parsed_filenames, @searched_filenames)
+  end
+
+  def test_should_compare_filenames
+    assert { @compared.class == Array }
+    assert { @compared == (@searched_filenames - @parsed_filenames) }
+  end
+end

data/test/miss-marple/parser_test.rb

@@ -0,0 +1,14 @@
+require "test_helper"
+
+class MissMarple::ParserTest < MiniTest::Unit::TestCase
+  def test_should_tun_tests
+    assert { true == true }
+  end
+
+  def test_should_read_manifest
+    c = MissMarple::Parser.parse("test/fixtures/tree/manifest.css")
+
+    assert { c.class == Array }
+    assert { !c.empty? }
+  end
+end

data/test/miss-marple/searcher_test.rb

@@ -0,0 +1,10 @@
+require "test_helper"
+
+class MissMarple::SearcherTest < MiniTest::Unit::TestCase
+  def test_should_search_files
+    searcher = MissMarple::Searcher.search(["test/fixtures"])
+
+    assert { searcher.class == Array }
+    assert { !searcher.empty? }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.require
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'minitest/autorun'
+require 'wrong/adapters/minitest'

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: miss-marple
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jana Petrova
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: wrong
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Miss Marple provides an easy way to detect unused assets
+email:
+- janavpetrova@gmail.com
+executables:
+- miss-marple
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/miss-marple
+- lib/miss-marple.rb
+- lib/miss-marple/comparer.rb
+- lib/miss-marple/detector.rb
+- lib/miss-marple/logger.rb
+- lib/miss-marple/parser.rb
+- lib/miss-marple/searcher.rb
+- lib/miss-marple/version.rb
+- miss-marple.gemspec
+- test/fixtures/app.css
+- test/fixtures/tree/first.css
+- test/fixtures/tree/manifest.css
+- test/fixtures/tree/second.css
+- test/fixtures/ui/orange.css
+- test/miss-marple/comparer_test.rb
+- test/miss-marple/parser_test.rb
+- test/miss-marple/searcher_test.rb
+- test/test_helper.rb
+homepage: https://github.com/JanaVPetrova/miss-marple
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Detects unused assets
+test_files:
+- test/fixtures/app.css
+- test/fixtures/tree/first.css
+- test/fixtures/tree/manifest.css
+- test/fixtures/tree/second.css
+- test/fixtures/ui/orange.css
+- test/miss-marple/comparer_test.rb
+- test/miss-marple/parser_test.rb
+- test/miss-marple/searcher_test.rb
+- test/test_helper.rb