style_stats 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7780214f096be1c28f03ea84b95e7d74bea2eedf
-  data.tar.gz: 47a4b0a89188167f8612ba5dce3840f5c6f67120
+  metadata.gz: b9e2bb1732c0e4cdc94c37b106056de61bb4ba31
+  data.tar.gz: f48c01ac18fe8dd45dddce5484a196efd0908c9f
 SHA512:
-  metadata.gz: 283051e8c0e4bbfc685de1c807be32f3bbadb2a4d2a0152cad6932fd424de9e9633efc85953be091dcbbc72593a4ef336b1ec148bb83808e741c3279c50a59b6
-  data.tar.gz: 28adf7e15f5089a6ecc3ef7fd0924c68301d995c2f219ee5cf79f6801ab1c6d2747144561185d8645c3bb5f6c21c97867ba343c30d865e70df424ac6f6296f5e
+  metadata.gz: 0d22610c40f6a56429988720e4799dac8b7dbff11bdb2003a4e8ff1c74b4d7c1a3ac9f20caaf9a42de392f2b6bd91c9f1a03f3bdf858ab0e1a484220905082c6
+  data.tar.gz: 628ce17c2809742c77557c706ec86a8bd120de9aa14a0b6ee5eb02ea847e4700b7a0425a7853eb70461f13017b410cab2747c02c2c9f2f03f6cff970a9df8fd1

data/README.md

@@ -131,6 +131,37 @@ $ style_stats http://example.com/
 $ style_stats foo.css -f <json|html|md>
 ```
 
+:## CLI Reference
+
+Help:
+
+```shell
+$ style_stats --help
+Usage: style_stats [options] <file ...>
+    -h, --help                       output usage information
+    -V, --version                    output the version number
+    -c, --config <path>              set configurations
+    -f, --format <format>            set the output format <json|html|md>
+    -m, --mobile [name]              set the mobile user agent
+        --user-anget <string>        set the user agent</string></format></path>
+```
+
+Example:
+
+```shell
+$ style_stats path/to/stylesheet.css -c style_stats.yml
+┌────────────────────────────┬────────┐
+│ Style Sheets               │ 1      │
+├────────────────────────────┼────────┤
+│ Size                       │ 19.0KB │
+├────────────────────────────┼────────┤
+│ Gzipped Size               │ 3.7KB  │
+├────────────────────────────┼────────┤
+│ Total Unique Font Families │ 3      │
+└────────────────────────────┴────────┘
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec style_stats` to use the gem in this directory, ignoring other installed copies of this gem.

data/exe/style_stats

@@ -17,6 +17,8 @@ opt.on('-V', '--version', 'output the version number') do |v|
   exit
 end
 
+
+opt.on('-c', '--config <path>', 'set configurations') { |v| options[:config] = v }
 opt.on('-f', '--format <format>', 'set the output format <json|html|md>') { |v| options[:format] = v }
 opt.on('-m', '--mobile [name]', 'set the mobile user agent') { |v| options[:user_agent] = v || 'ios' }
 opt.on('--user-anget <string>', 'set the user agent') { |v| options[:user_agent] = v }

data/lib/style_stats.rb

@@ -4,8 +4,17 @@ require 'open-uri'
 require 'css_parser'
 require 'json'
 require 'command_line_reporter'
+require 'yaml'
 
 class StyleStats
+  def self.configure(&block)
+    yield(configuration)
+  end
+
+  def self.configuration
+    @_configuration ||= StyleStats::Configuration.new
+  end
+
   def initialize(paths, options = {})
     paths = [paths] unless paths.is_a?(Array)
 
@@ -16,22 +25,16 @@ class StyleStats
     end.flatten
 
     @css = files.inject(Css.new) do |css, file|
-      css.merge!(Css.new(file, css_options))
+      css.merge!(Css.new(file))
     end
   end
 
   def render
-    Template.new(@css, template_options).render
+    Template.new(@css, options).render
   end
 
   private
-  def css_options
-    {
-      user_agent: @options[:user_agent]
-    }
-  end
-
-  def template_options
+  def options
     {
       format: @options[:format]
     }
@@ -39,6 +42,7 @@ class StyleStats
 end
 
 require 'style_stats/version'
+require 'style_stats/configuration'
 require 'style_stats/path_parser'
 require 'style_stats/css'
 require 'style_stats/template'

data/lib/style_stats/cli.rb

@@ -3,6 +3,11 @@ class StyleStats
     class << self
       def run(files, option)
         @options = option
+        StyleStats.configure do |config|
+          config.options[:requestOptions][:headers]['User-Agent'] = user_agent
+          config.options.merge!(configuration)
+        end
+
         stylestats = StyleStats.new(files, options)
         stylestats.render
       rescue StyleStats::RequestError
@@ -16,8 +21,7 @@ class StyleStats
       private
       def options
         {
-          format: @options[:format],
-          user_agent: user_agent
+          format: @options[:format]
         }
       end
 
@@ -31,6 +35,18 @@ class StyleStats
           @options[:user_agent]
         end
       end
+
+      def configuration
+        config = case File.extname(@options[:config].to_s)
+                 when '.yml', '.yaml'
+                   YAML.load_file(@options[:config])
+                 when '.json'
+                   json = File.read(@options[:config])
+                   JSON.parse(json)
+                 else
+                   {}
+                 end
+      end
     end
   end
 end

data/lib/style_stats/configuration.rb

@@ -0,0 +1,43 @@
+class StyleStats
+  class Configuration
+    def options
+      @options ||= {
+        published:                     true,
+        stylesheets:                   true,
+        paths:                         true,
+        stylesheets:                   true,
+        styleElements:                 true,
+        size:                          true,
+        dataUriSize:                   true,
+        ratioOfDataUriSize:            true,
+        gzippedSize:                   true,
+        rules:                         true,
+        selectors:                     true,
+        declarations:                  true,
+        simplicity:                    true,
+        averageOfIdentifier:           true,
+        mostIdentifier:                true,
+        mostIdentifierSelector:        true,
+        averageOfCohesion:             true,
+        lowestCohesion:                true,
+        lowestCohesionSelector:        true,
+        totalUniqueFontSizes:          true,
+        uniqueFontSizes:               true,
+        totalUniqueFontFamilies:       true,
+        uniqueFontFamilies:            true,
+        totalUniqueColors:             true,
+        uniqueColors:                  true,
+        idSelectors:                   true,
+        universalSelectors:            true,
+        unqualifiedAttributeSelectors: true,
+        javascriptSpecificSelectors:   "[#\\.]js\\-",
+        userSpecifiedSelectors:        false,
+        importantKeywords:             true,
+        floatProperties:               true,
+        propertiesCount:               10,
+        mediaQueries:                  true,
+        requestOptions:                { headers: {} }
+      }
+    end
+  end
+end

data/lib/style_stats/css.rb

@@ -8,7 +8,7 @@ class StyleStats
   class Css
     attr_accessor :path, :paths, :rules, :media_types, :selectors, :stylesheets, :elements
 
-    def initialize(path = nil, options = {})
+    def initialize(path = nil)
       self.path = path
       self.paths = path ? [path] : []
       self.rules = []
@@ -17,7 +17,6 @@ class StyleStats
       self.stylesheets = []
       self.elements = []
 
-      @options = options
       parse if path
     end
 
@@ -61,7 +60,17 @@ class StyleStats
       when :unqualified
         selectors.count { |selector| selector.name.match(/\[.+\]$/) }
       when :js
-        selectors.count { |selector| selector.name.match(/[#\\.]js\\-/) }
+        if StyleStats.configuration.options[:javascriptSpecificSelectors]
+          selectors.count { |selector| selector.name.match(/#{StyleStats.configuration.options[:javascriptSpecificSelectors]}/) }
+        else
+          0
+        end
+      when :user
+        if StyleStats.configuration.options[:userSpecifiedSelectors]
+          selectors.count { |selector| selector.name.match(/#{StyleStats.configuration.options[:userSpecifiedSelectors]}/) }
+        else
+          0
+        end
       else
         selectors.count
       end
@@ -96,7 +105,7 @@ class StyleStats
 
     private
     def parse
-      fetch = Fetch.new(self.path, @options)
+      fetch = Fetch.new(self.path)
 
       self.stylesheets = fetch.stylesheets
       self.elements = fetch.elements

data/lib/style_stats/css/analyze.rb

@@ -1,42 +1,176 @@
 class StyleStats
   class Css
     def analyze
-      selector = sort_selector_by_declarations_count.first
-      most_indentifier_selector = selectors.first || StyleStats::Css::Selector.new
-      {
-        "Published"                       => Time.now,
-        "Paths"                           => paths,
-        "Style Sheets"                    => stylesheets.count,
-        "Style Elements"                  => elements.count,
-        "Size"                            => size,
-        "Data URI Size"                   => data_uri_size,
-        "Ratio of Data URI Size"          => "#{data_uri_size.fdiv(size).round(1) * 100}%",
-        "Gzipped Size"                    => gzipped_size,
-        "Rules"                           => rules.count,
-        "Selectors"                       => selectors.count,
-        "Declarations"                    => declarations.count,
-        "Simplicity"                      => "#{rules.count.fdiv(selectors.count).round(1) * 100}%",
-        "Average of Identifier"           => selectors.map(&:identifier_count).inject(0, :+).fdiv(selectors.count).round(3),
-        "Most Identifier"                 => most_indentifier_selector.identifier_count,
-        "Most Identifier Selector"        => most_indentifier_selector.name,
-        "Average of Cohesion"             => declarations.count.fdiv(rules.count).round(3),
-        "Lowest Cohesion"                 => selector.declarations.count,
-        "Lowest Cohesion Selector"        => selector.name,
-        "Total Unique Font Sizes"         => self["font-size"][:values].count,
-        "Unique Font Sizes"               => self["font-size"][:values],
-        "Total Unique Font Families"      => self["font-family"][:values].count,
-        "Unique Font Families"            => self["font-family"][:values],
-        "Total Unique Colors"             => self["color"][:values].count,
-        "Unique Colors"                   => self["color"][:values],
-        "ID Selectors"                    => selectors_count(:id),
-        "Universal Selectors"             => selectors_count(:universal),
-        "Unqualified Attribute Selectors" => selectors_count(:unqualified),
-        "JavaScript Specific Selectors"   => selectors_count(:js),
-        "Important Keywords"              => declarations_count(:important),
-        "Float Properties"                => declarations_count(:float),
-        "Properties Count"                => aggregate_declaration.declarations.sort { |(_, v1), (_, v2)| v2[:count] <=> v1[:count] }.take(10).map{ |property, declaration| "#{property}: #{declaration[:count]}" },
-        "Media Queries"                   => media_types.count
-      }
+      @result = {}
+      @selector = sort_selector_by_declarations_count.first
+      @most_indentifier_selector = selectors.first || StyleStats::Css::Selector.new("")
+      analyze_published
+      analyze_paths
+      analyze_stylesheets
+      analyze_style_elements
+      analyze_size
+      analyze_data_uri_size
+      analyze_ratio_of_data_uri_size
+      analyze_gzipped_size
+      analyze_rules
+      analyze_selectors
+      analyze_declarations
+      analyze_simplicity
+      analyze_average_of_identifier
+      analyze_most_identifier
+      analyze_most_identifier_selector
+      analyze_average_of_cohesion
+      analyze_lowest_cohesion
+      analyze_lowest_cohesion_selector
+      analyze_total_unique_font_sizes
+      analyze_unique_font_sizes
+      analyze_total_unique_font_families
+      analyze_unique_font_families
+      analyze_total_unique_colors
+      analyze_unique_colors
+      analyze_id_selectors
+      analyze_universal_selectors
+      analyze_unqualified_attribute_selectors
+      analyze_javascript_specific_selectors
+      analyze_user_specific_selectors
+      analyze_important_keywords
+      analyze_fload_properties
+      analyze_properties_count
+      analyze_media_queries
+      @result
+    end
+
+    private
+    def analyze_published
+      @result["Published"] = Time.now if StyleStats.configuration.options[:published]
+    end
+
+    def analyze_paths
+      @result["Paths"] = paths if StyleStats.configuration.options[:paths]
+    end
+
+    def analyze_stylesheets
+      @result["Style Sheets"] = stylesheets.count if StyleStats.configuration.options[:stylesheets]
+    end
+
+    def analyze_style_elements
+      @result["Style Elements"] = elements.count if StyleStats.configuration.options[:styleElements]
+    end
+
+    def analyze_size
+      @result["Size"] = size if StyleStats.configuration.options[:size]
+    end
+
+    def analyze_data_uri_size
+      @result["Data URI Size"] = data_uri_size if StyleStats.configuration.options[:dataUriSize]
+    end
+
+    def analyze_ratio_of_data_uri_size
+      @result["Ratio of Data URI Size"] = "#{data_uri_size.fdiv(size).round(1) * 100}%" if StyleStats.configuration.options[:ratioOfDataUriSize]
+    end
+
+    def analyze_gzipped_size
+      @result["Gzipped Size"] = gzipped_size if StyleStats.configuration.options[:gzippedSize]
+    end
+
+    def analyze_rules
+      @result["Rules"] = rules.count if StyleStats.configuration.options[:rules]
+    end
+
+    def analyze_selectors
+      @result["Selectors"] = selectors.count if StyleStats.configuration.options[:selectors]
+    end
+
+    def analyze_declarations
+      @result["Declarations"] = declarations.count if StyleStats.configuration.options[:declarations]
+    end
+
+    def analyze_simplicity
+      @result["Simplicity"] = "#{rules.count.fdiv(selectors.count).round(1) * 100}%" if StyleStats.configuration.options[:simplicity]
+    end
+
+    def analyze_average_of_identifier
+      @result["Average of Identifier"] = selectors.map(&:identifier_count).inject(0, :+).fdiv(selectors.count).round(3) if StyleStats.configuration.options[:averageOfIdentifier]
+    end
+
+    def analyze_most_identifier
+      @result["Most Identifier"] = @most_indentifier_selector.identifier_count if StyleStats.configuration.options[:mostIdentifier]
+    end
+
+    def analyze_most_identifier_selector
+      @result["Most Identifier Selector"] = @most_indentifier_selector.name if StyleStats.configuration.options[:mostIdentifierSelector]
+    end
+
+    def analyze_average_of_cohesion
+      @result["Average of Cohesion"] = declarations.count.fdiv(rules.count).round(3) if StyleStats.configuration.options[:averageOfCohesion]
+    end
+
+    def analyze_lowest_cohesion
+      @result["Lowest Cohesion"] = @selector.declarations.count if StyleStats.configuration.options[:lowestCohesion]
+    end
+
+    def analyze_lowest_cohesion_selector
+      @result["Lowest Cohesion Selector"] = @selector.name if StyleStats.configuration.options[:lowestCohesionSelector]
+    end
+
+    def analyze_total_unique_font_sizes
+      @result["Total Unique Font Sizes"] = self["font-size"][:values].count if StyleStats.configuration.options[:totalUniqueFontSizes]
+    end
+
+    def analyze_unique_font_sizes
+      @result["Unique Font Sizes"] = self["font-size"][:values] if StyleStats.configuration.options[:uniqueFontSizes]
+    end
+
+    def analyze_total_unique_font_families
+      @result["Total Unique Font Families"] = self["font-family"][:values].count if StyleStats.configuration.options[:totalUniqueFontFamilies]
+    end
+
+    def analyze_unique_font_families
+      @result["Unique Font Families"] = self["font-family"][:values] if StyleStats.configuration.options[:uniqueFontFamilies]
+    end
+
+    def analyze_total_unique_colors
+      @result["Total Unique Colors"] = self["color"][:values].count if StyleStats.configuration.options[:totalUniqueColors]
+    end
+
+    def analyze_unique_colors
+      @result["Unique Colors"] = self["color"][:values] if StyleStats.configuration.options[:uniqueColors]
+    end
+
+    def analyze_id_selectors
+      @result["ID Selectors"] = selectors_count(:id) if StyleStats.configuration.options[:idSelectors]
+    end
+
+    def analyze_universal_selectors
+      @result["Universal Selectors"] = selectors_count(:universal) if StyleStats.configuration.options[:universalSelectors]
+    end
+
+    def analyze_unqualified_attribute_selectors
+      @result["Unqualified Attribute Selectors"] = selectors_count(:unqualified) if StyleStats.configuration.options[:unqualifiedAttributeSelectors]
+    end
+
+    def analyze_javascript_specific_selectors
+      @result["JavaScript Specific Selectors"] = selectors_count(:js) if StyleStats.configuration.options[:javascriptSpecificSelectors]
+    end
+
+    def analyze_user_specific_selectors
+      @result["User Specific Selectors"] = selectors_count(:user) if StyleStats.configuration.options[:userSpecificSelectors]
+    end
+
+    def analyze_important_keywords
+      @result["Important Keywords"] = declarations_count(:important) if StyleStats.configuration.options[:importantKeywords]
+    end
+
+    def analyze_fload_properties
+      @result["Float Properties"] = declarations_count(:float) if StyleStats.configuration.options[:floatProperties]
+    end
+
+    def analyze_properties_count
+      @result["Properties Count"] = aggregate_declaration.declarations.sort { |(_, v1), (_, v2)| v2[:count] <=> v1[:count] }.take(10).map{ |property, declaration| "#{property}: #{declaration[:count]}" } if StyleStats.configuration.options[:propertiesCount]
+    end
+
+    def analyze_media_queries
+      @result["Media Queries"] = media_types.count if StyleStats.configuration.options[:mediaQueries]
     end
   end
 end

data/lib/style_stats/css/fetch.rb

@@ -2,10 +2,9 @@ class StyleStats::Css
   class Fetch
     attr_accessor :stylesheets, :elements
 
-    def initialize(path, options={})
+    def initialize(path)
       self.stylesheets = []
       self.elements = []
-      @options = options
       get(path)
     end
 
@@ -19,7 +18,7 @@ class StyleStats::Css
     end
 
     def request(path)
-      file = open(path, "User-Agent" => user_agent)
+      file = open(path, headers)
       case file.content_type
       when 'text/css'
         self.stylesheets.push(file.read)
@@ -49,8 +48,12 @@ class StyleStats::Css
       end
     end
 
-    def user_agent
-      @options[:user_agent] || "Ruby/StyleStats #{StyleStats::VERSION}"
+    def headers
+      if StyleStats.configuration.options[:requestOptions][:headers]['User-Agent']
+        StyleStats.configuration.options[:requestOptions][:headers]
+      else
+        { 'User-Agent' => "Ruby/StyleStats #{StyleStats::VERSION}" }
+      end
     end
   end
 end

data/lib/style_stats/version.rb

@@ -1,3 +1,3 @@
 class StyleStats
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: style_stats
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - shiro16
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-01 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oga
@@ -116,6 +116,7 @@ files:
 - exe/style_stats
 - lib/style_stats.rb
 - lib/style_stats/cli.rb
+- lib/style_stats/configuration.rb
 - lib/style_stats/css.rb
 - lib/style_stats/css/aggregate_declaration.rb
 - lib/style_stats/css/analyze.rb
@@ -155,4 +156,3 @@ signing_key:
 specification_version: 4
 summary: StyleStats is a library to collect CSS statistics!
 test_files: []
-has_rdoc: