dftsg 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd1d096457fc638d82475c05c61021cdeb1677ca
+  data.tar.gz: c5dee1bd92bab45600463e6e4220030862e426c4
+SHA512:
+  metadata.gz: 290ea22bcf6f04dddf6e9ecb8e5e28cc50417131d5cf198a168f14eb6b6b46589ac735fe27ed0c43f3e4259aefbad899c9d042369ca6d720bd505f67e33133ba
+  data.tar.gz: 7460156a21c138fe88c2a34b2f87c6c2c5a5bbee89462b4e60a6578215f4269fb1099ea0b7be732273dd1f3730843b8eb0b05d973a6a9b528bd2c44ee984c401

data/.gitignore

@@ -0,0 +1 @@
+*DS_Store*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christopher John Morris
+
+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,21 @@
+# dftsg
+
+Generates a report of how well a directory of Swift files conforms to the Dafiti Swift Style Guide
+
+## Installation
+
+To install:
+
+    $ gem install dftsg
+
+Depending on your gem env, you may have to add the executable's path to $PATH
+
+## Usage
+
+To create a report:
+
+    $ dftsg gen directory/of/swift/files
+
+To create a report and set the output directory:
+
+    $ dftsg gen directory/of/swift/files --output directory/of/report

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dftsg"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/dftsg

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+
+require_relative '../lib/FormGenerator'
+
+input = nil
+
+program :version, '0.0.1'
+program :description, 'Validates Swift Style Guide'
+ 
+command :gen do |c|
+  c.syntax = 'dftsg gen directory/with/Swift/files'
+  c.summary = ''
+  c.description = ''
+  c.example 'description', 'dftsg input '
+  c.option '--output STRING', 'Optional output directory'
+  c.action do |args, options|
+    if args.count == 0
+      puts
+      puts "You must provide the directory of Swift files to analyze:"
+      puts
+      puts "\t dftsg gen directory/with/Swift/files"
+      puts
+    else
+      input = args.first
+      output = options.output
+
+      formGenerator = FormGenerator.new(input, output)
+      formGenerator.generateForm
+    end
+  end
+end

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dftsg.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dftsg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dftsg"
+  spec.version       = Dftsg::VERSION
+  spec.authors       = ['Christopher John Morris']
+  spec.email         = %w(christopher.morris@dafiti.com.br)
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'http://rubygems.org'
+  end
+
+  spec.summary       = 'Simple Swift Style Guide analyzer'
+  spec.description   = 'A Swift Style Guide analyzer that generates a report showing how well a file or files conform to the Style Guide.'
+  spec.homepage      = 'http://rubygems.org'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency "commander", "~> 4.2.0"
+  
+end

data/lib/AnalysisHTMLFile.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+
+require_relative 'LineType'
+require_relative 'LineDeterminator'
+require 'fileutils'
+
+class AnalysisHTMLFile
+    def initialize (directory, name)
+        @directory = "#{directory}/#{File.dirname(name.gsub("./", ""))}"
+        @name = name.gsub("#{File.dirname(name)}", "").gsub("/", "")
+        @validLines = 0
+        @invalidLines = 0
+        @totalLines = 0
+    end
+    
+    def beginWriting
+        FileUtils::mkdir_p "#{@directory}"
+        @fileHtml = File.new("#{@directory}/#{@name}.html", "w+")
+        @fileHtml.puts "<HTML><BODY>"
+        @fileHtml.puts "<pre>"
+    end
+    
+    def addLine (line)
+        lineType = LineDeterminator.new(line).lineType
+        @totalLines += 1
+        if lineType != nil
+            if lineType.instance_of? ClassLineType or lineType.instance_of? VariableLineType or lineType.instance_of? ConstantLineType or lineType.instance_of? CommentLineType
+                font = "<font size=\"3\""
+                if !lineType.isValid
+                    font += "color=\"red\""
+                    @invalidLines += 1
+                else
+                    font += "color=\"#52CC52\""
+                    @validLines += 1
+                end
+                font += ">#{line.chomp}</font>"
+                @fileHtml.puts font
+            else
+                @fileHtml.puts "<code>#{line.chomp}</code>"
+            end
+        end
+    end
+    
+    def endWriting
+        @fileHtml.puts "</pre>"
+        @fileHtml.puts "</BODY></HTML>"
+        @fileHtml.close()
+    end
+
+    def directory
+        @directory
+    end
+
+    def name
+        @name
+    end
+
+    def validLines
+        @validLines
+    end
+
+    def invalidLines
+        @invalidLines
+    end
+
+    def totalLines
+        @totalLines
+    end
+
+end

data/lib/FormGenerator.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+
+require_relative 'LineDeterminator'
+require_relative 'IndexHTMLFile'
+require_relative 'AnalysisHTMLFile'
+
+class FormGenerator
+
+	def initialize(searchDirectoryArg, outputDirectory)
+
+		@analysisDirectory = "SwiftStyleGuideValidator"
+		if outputDirectory != nil
+			@analysisDirectory = "#{outputDirectory}/#{@analysisDirectory}"
+		end
+
+		@filesDir = "AnalysisFiles"
+
+		@searchDirectoryArg = "."
+		if searchDirectoryArg != nil
+			@searchDirectoryArg = searchDirectoryArg
+			@searchDirectoryArg = searchDirectoryArg.chomp("/") 
+		end
+
+	end
+
+	def generateForm
+		if directoryHasSwiftFiles == true
+			if File.directory?(@analysisDirectory)
+				FileUtils.rm_rf(@analysisDirectory)
+			end
+			Dir.mkdir(@analysisDirectory)
+
+			@IndexHTMLFile = IndexHTMLFile.new(@analysisDirectory)
+			@IndexHTMLFile.beginWriting
+            
+            counter = 0
+            
+			Dir.glob("#{@searchDirectoryArg}/**/*.swift") do |item|
+			  	next if item == '.' or item == '..'
+			  	addItem item
+                counter += 1
+                if counter % 50 == 0
+                    print "Files processed: #{counter}\r"
+                end
+			end
+            puts
+
+			@IndexHTMLFile.endWriting
+		else
+			puts "No Swift files found in directory #{@searchDirectoryArg}"
+		end
+	end
+
+	def addItem (item)
+		analysisFile = AnalysisHTMLFile.new("#{@analysisDirectory}/#{@filesDir}", item)
+	  	analysisFile.beginWriting
+	  	
+	  	f = File.open(item, "r")
+		f.each_line do |line|
+			analysisFile.addLine (line)
+		end
+		f.close
+
+		@IndexHTMLFile.addAnalysisItem (analysisFile)
+
+		analysisFile.endWriting
+	end
+
+	def directoryHasSwiftFiles
+		hasSwiftFiles = false
+		Dir.glob("#{@searchDirectoryArg}/**/*.swift") do |item|
+		  	next if item == '.' or item == '..' 
+		  	hasSwiftFiles = true
+		  	break
+		end
+		hasSwiftFiles
+	end
+end

data/lib/IndexHTMLFile.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+
+class IndexHTMLFile
+
+	def initialize(directory)
+		@directory = directory
+		@totalLines = 0
+		@totalValidLines = 0
+		@totalInvalidLines = 0
+		@indexHTMLString = ""
+	end
+
+	def beginWriting
+		@indexHTML = File.new("#{@directory}/index.html", "w+")
+	end
+
+	def addAnalysisItem (analysisFile)
+		@totalLines += analysisFile.totalLines
+		@totalInvalidLines += analysisFile.invalidLines
+		@totalValidLines += analysisFile.validLines
+
+		htmlFileName = analysisFile.name
+		htmlFileName = htmlFileName.gsub(".swift", "")
+		htmlFileName = htmlFileName.gsub("./", "")
+
+		@indexHTMLString += "<tr>"
+		@indexHTMLString += "\n<td>"
+		@indexHTMLString += "\n<a href=\"#{analysisFile.directory.gsub(@directory + "/", "")}/#{analysisFile.name}.html\">#{htmlFileName}.html</a>"
+		@indexHTMLString += "\n</td>"
+		@indexHTMLString += "\n<td align=\"center\">"
+		@indexHTMLString += "\n#{analysisFile.invalidLines}"
+		@indexHTMLString += "\n</td>"
+
+        validLinePercentage = ((analysisFile.invalidLines / Float(analysisFile.totalLines) - 1) * -100).round
+        color = colorForValidLinePercentage validLinePercentage
+		@indexHTMLString += "\n<td align=\"center\" bgcolor=\"#{color}\">"
+		@indexHTMLString += "\n#{validLinePercentage}%"
+		@indexHTMLString += "\n</td>"
+		@indexHTMLString += "\n</tr>"
+	end
+    
+    def addTotalStatsTable
+        @indexHTML.puts "<table cellpadding=\"0\" cellspacing=\"10\" class=\"table\" bgcolor=\"#E8E8E8\" col width=\"800\">"
+        @indexHTML.puts "<tr>"
+        @indexHTML.puts "<th>Total Lines</th>"
+        @indexHTML.puts "<th>Invalid Lines</th>"
+        @indexHTML.puts "<th>Valid Lines</th>"
+        @indexHTML.puts "<th>Percent Valid</th>"
+        @indexHTML.puts "</tr>"
+        
+        @indexHTML.puts "<tr>"
+        
+        @indexHTML.puts "<td align=\"center\">"
+        @indexHTML.puts "#{@totalLines}"
+        @indexHTML.puts "</td>"
+        
+        @indexHTML.puts "<td align=\"center\">"
+        @indexHTML.puts "#{@totalInvalidLines}"
+        @indexHTML.puts "</td>"
+        
+        @indexHTML.puts "<td align=\"center\">"
+        @indexHTML.puts "#{@totalValidLines}"
+        @indexHTML.puts "</td>"
+        
+        validLinePercentage = ((@totalInvalidLines / Float(@totalLines) - 1) * -1 * 100).round
+        color = colorForValidLinePercentage validLinePercentage
+        @indexHTML.puts "<td align=\"center\" bgcolor=\"#{color}\">"
+        @indexHTML.puts "#{validLinePercentage}%"
+        @indexHTML.puts "</td>"
+        
+        @indexHTML.puts "</tr>"
+        
+        @indexHTML.puts "</table>"
+    end
+    
+    def addAnalysisFilesTable
+        @indexHTML.puts "<table cellpadding=\"0\" cellspacing=\"10\" class=\"table\" bgcolor=\"#E8E8E8\" col width=\"800\">"
+        @indexHTML.puts "<tr>"
+        @indexHTML.puts "<th>File</th>"
+        @indexHTML.puts "<th>Invalid Statements</th>"
+        @indexHTML.puts "<th>Percent Valid</th>"
+        @indexHTML.puts "</tr>"
+        @indexHTML.puts @indexHTMLString
+        @indexHTML.puts "</table>"
+    end
+    
+    def colorForValidLinePercentage (percentage)
+        if percentage >= 95
+            return "#52CC52" # Green
+        end
+
+        if percentage >= 90 and percentage < 95
+           return "yellow"
+        end
+
+        if percentage < 90
+           return "#FF0000" # Red 
+        end
+    end
+
+	def endWriting
+		@indexHTML.puts "<HTML><BODY>"
+		addTotalStatsTable
+		addAnalysisFilesTable
+		@indexHTML.puts "</BODY></HTML>"
+		@indexHTML.close()
+	end
+end

data/lib/LineDeterminator.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+class LineDeterminator
+    def initialize (line)
+        @strippedLine = line.strip
+    end
+    
+    def isComment
+        @strippedLine[0...2] == "//" or @strippedLine[0...3] == "///"
+    end
+    
+    def isVar
+        @strippedLine[0...3] == "var"
+    end
+    
+    def isLet
+        @strippedLine[0...3] == "let"
+    end
+    
+    def isClass
+        @strippedLine[0...5] == "class"
+    end
+    
+    def isFunction
+        @strippedLine[0...4] == "func"
+    end
+    
+    def lineType
+        if isComment
+            return CommentLineType.new(@strippedLine)
+        end
+        
+        if isVar
+            return VariableLineType.new(@strippedLine)
+        end
+        
+        if isLet
+            return ConstantLineType.new(@strippedLine)
+        end
+        
+        if isClass
+            return ClassLineType.new(@strippedLine)
+        end
+        
+        return LineType.new(@strippedLine)
+    end
+end

data/lib/LineType.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+class LineType
+	def initialize (strippedLine)
+		@strippedLine = strippedLine
+	end
+
+	def isValid 
+		!(s[-1] != ";")
+	end
+end
+
+class VariableLineType < LineType
+
+	UNINITIALIZED_REGEX = /var[" "]([a-zA-Z0-9])\w+: [a-zA-Z]*([!]?[?]?)/
+	INITIALIZED_REGEX = /var[" "]([a-zA-Z0-9])\w+ = ([a-zA-Z0-9]?"?[(]?[)]?.?)*/
+
+	def isValid 
+		isValidUninitialized || isValidInitialized
+		# super.isValid && (isValidUninitialized || isValidInitialized)
+	end
+
+	def isValidUninitialized
+		!!(@strippedLine =~ UNINITIALIZED_REGEX) && !(@strippedLine.include? "=")
+	end
+
+	def isValidInitialized
+		!!(@strippedLine =~ INITIALIZED_REGEX)
+	end
+end
+
+class ConstantLineType < LineType
+
+	UNINITIALIZED_REGEX = /let[" "]([a-zA-Z0-9])\w+: [a-zA-Z]*([!]?[?]?)/
+	INITIALIZED_REGEX = /let[" "]([a-zA-Z0-9])\w+ = ([a-zA-Z0-9]?"?[(]?[)]?.?)*/
+
+	def isValid 
+		isValidUninitialized || isValidInitialized
+		# super.isValid && isValidUninitialized || isValidInitialized
+	end
+
+	def isValidUninitialized
+		!!(@strippedLine =~ UNINITIALIZED_REGEX) && !(@strippedLine.include? "=")
+	end
+
+	def isValidInitialized
+		!!(@strippedLine =~ INITIALIZED_REGEX)
+	end
+end
+
+class ClassLineType < LineType
+
+	CLASS_REGEX = /class[" "]([a-zA-Z])\w+((: (([a-zA-Z])\w+))((, (([a-zA-Z])\w+)){0,10}))? {/
+
+	def isValid
+		!!(@strippedLine =~ CLASS_REGEX)
+	end
+
+end
+
+class CommentLineType < LineType
+
+	COMMENT_WITH_COMMENTS_REGEX = /\/\/\/?(( (?=.))(.{0,}))/
+	COMMENT_WITHOUT_COMMENTS_REGEX = /\/\/\/?(?!.)/
+
+	def isValid
+		!!(@strippedLine =~ COMMENT_WITH_COMMENTS_REGEX) || !!(@strippedLine =~ COMMENT_WITHOUT_COMMENTS_REGEX)
+	end
+
+end
+

data/lib/dftsg/version.rb

@@ -0,0 +1,3 @@
+module Dftsg
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: dftsg
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Christopher John Morris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: A Swift Style Guide analyzer that generates a report showing how well
+  a file or files conform to the Style Guide.
+email:
+- christopher.morris@dafiti.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/dftsg
+- bin/setup
+- dftsg.gemspec
+- lib/AnalysisHTMLFile.rb
+- lib/FormGenerator.rb
+- lib/IndexHTMLFile.rb
+- lib/LineDeterminator.rb
+- lib/LineType.rb
+- lib/dftsg/version.rb
+- pkg/dftsg-0.1.0.gem
+homepage: http://rubygems.org
+licenses:
+- MIT
+metadata:
+  allowed_push_host: http://rubygems.org
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Simple Swift Style Guide analyzer
+test_files: []