giteaucrat 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YWQ5ZjA3Yzk3OGU1OTIwNWU3NmYyMjkyYzJmNGFjYzk0NTY4MGU1ZQ==
+    NDljY2ZhYWJmNTMxNmJiYzJhN2UwMGIyYzU0YmExYTY1Njc4MmQ0Nw==
   data.tar.gz: !binary |-
-    NDlhZWYxZDU2ZjIxMmY3MWIzZTA2NDk2ZjVmMWFmNDY1Y2M1NTFkYg==
+    MDQyZWVlN2RlMjg2ZjU0OTFjZTI3ZDIwMDYwODY2ZThhMDFjMTlmYQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDJkMjJmZDIwNzIyODE4ZTYxNWQ3YzQ3MGYxMDE3NmMxNzJmMzlkNjFjMjk4
-    MzVlNjRkNjY1ZDdkNGExOWRlMWQ0YWIxYWEwZjk2ZGIxYzZlMjljY2U4NDU1
-    ZDYwY2E2MGZkNWI4M2MzZGM0Mjc3ODE1NzdlMTZmYjc0MmNkM2I=
+    MzU3MWI4YTkzMzE3MWYzYTY5NWFmNmEwMzhhYWIyZGYyMjBiNjYxYTU3ZDA5
+    NDkxNDI4YWUyMzZiZTZiNGJkZDYyNzM3NjQyN2Y2MTU5N2NhODAxOGVkODYx
+    ZDg2ZjM0Y2M2M2ZhMGEwNGE5NGFmNGM3YjA4Mjk1YzdlZjdjNDk=
   data.tar.gz: !binary |-
-    NDAxMGFiNGY1NzdlNzZiMjAyZDMyNWY2MzFlMmY0NjZhYWUxZjUxZWVkYzI4
-    YWMzNzlhYTZkNjE5YmM3MmU4Y2E4OWRmZTEwOTYyZmFkYjE3YTJiNzkxMDU2
-    ZTRmYmYxMDRkZGY4OTM5MDM5NWFiMTc4ZGRmOWNmYWY3MGRkZGU=
+    M2U1OGU3NzkxYzY2YWRkMWE4NTdiOTJiZTkxMjQ2Y2IyODU1NTVhZjcxZDRj
+    ZTI5ZjU2NmM0MTNlMDMyYzA1MjE4NjA3NGRmMWI0NGQ5OGIzMzdhMTMxMzQ2
+    YjhhOGVhMjkzZmQ1NWI1YTUyMjRhZTc4YWU2ZWJjNGM0N2Q3ZDc=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+© Alexander Semyonov, 2013
+
+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

@@ -27,3 +27,5 @@ You can see all available options using:
 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
+
+© Alexander Semyonov, 2013. See MIT-LICENSE for details

data/config/giteaucrat.yml

@@ -1,5 +1,6 @@
 ---
 commit_keyword: "#giteaucrat"
 copyright_owner: Alexander Semyonov
-copyright_format: "© %{owner}, %{years}"
+copyright_format: "© %{owner}, %{years}, %{license}"
 include_encoding: true
+license: MIT License

data/lib/giteaucrat/author.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 ################################################
-# © Alexander Semyonov, 2013—2013              #
+# © Alexander Semyonov, 2013—2013, MIT License #
 # Author: Alexander Semyonov <al@semyonov.us>  #
 ################################################
 

data/lib/giteaucrat/common.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 ################################################
-# © Alexander Semyonov, 2013—2013              #
+# © Alexander Semyonov, 2013—2013, MIT License #
 # Author: Alexander Semyonov <al@semyonov.us>  #
 ################################################
 

data/lib/giteaucrat/file.rb

@@ -1,13 +1,14 @@
 # coding: utf-8
 
 ################################################
-# © Alexander Semyonov, 2013—2013              #
+# © Alexander Semyonov, 2013—2013, MIT License #
 # Author: Alexander Semyonov <al@semyonov.us>  #
 ################################################
 
 require 'giteaucrat'
 require 'grit'
 require 'core_ext/grit/blame'
+require 'giteaucrat/formatters'
 
 module Giteaucrat
   class File
@@ -24,7 +25,7 @@ module Giteaucrat
         blame = repo.git_repo.blame(name)
         lines = blame.lines
         commits = lines.map { |line| line.commit }.uniq.find_all do |commit|
-          !ignored_commit?(commit)
+          !repo.ignored_commit?(commit)
         end
         commits.inject(Set.new) do |authors, commit|
           author = Author.find_by_git_person(commit.author)
@@ -34,78 +35,26 @@ module Giteaucrat
       end
     end
 
-    def write_copyright!
-      first, middle, last = comment
-      first = Regexp.escape(first)
-      middle = Regexp.escape(middle)
-      last = Regexp.escape(last)
-      contents = ::File.read(name)
-      ruler = "(#{first}(#{middle})*#{last}\n)"
-      coding = "\\A(#{first}\s*.*coding:\s*utf-8\s*\n+)?"
-      header = /#{coding}#{ruler}(#{first}.*#{last}\n)*\2\n*/m
-      if repo.include_encoding?
-        contents.sub!(header, '')
-        contents.sub!(/#{coding}/, '')
-        contents = "#{copyright}\n\n#{contents}"
-      else
-        contents.sub!(/(#{coding})/, "\1#{copyright}\n\n")
+    def owner
+      @owner ||= begin
+        Author.find_by_git_person(repo.git_repo.log(name).last.author)
       end
-      ::File.write(name, contents)
     end
 
-    def copyright
-      @copyright ||= begin
-        lines = []
-        lines << repo.copyright_label
-
-        if authors.size > 0
-          authors_label = (authors.size > 1) ? 'Authors: ' : 'Author: '
-          author_names = self.authors.map { |a| a.identifier }.sort
-          prepend = ' ' * authors_label.size
-          lines << "#{authors_label}#{author_names.shift}"
-          author_names.each do |author|
-            lines << "#{prepend}#{author}"
-          end
-        end
-
-        first, middle, last = self.comment
-
-        max_line_size = lines.max { |a, b| a.size <=> b.size }.size
-        max_line_size += 1 if max_line_size.odd?
-
-        width = first.size + 1 + max_line_size + 1 + last.size
-        ruler = "#{first}#{middle * ((width / middle.size - first.size - last.size))}#{last}"
-        lines = lines.map do |line|
-          blank = ' ' * (max_line_size - line.size) if line.size < max_line_size
-          "#{first} #{line}#{blank} #{last}"
-        end
+    def read_contents
+      ::File.read(name)
+    end
 
-        lines.unshift(ruler)
-        lines << ruler
-        if repo.include_encoding?
-          lines.unshift("#{first} coding: utf-8\n")
-        end
-        lines.join("\n")
-      end
+    def write_contents(contents)
+      ::File.write(name, contents)
     end
 
-    # @see Giteaucrat::Repo#ignored_commit?
-    def ignored_commit?(commit)
-      repo.ignored_commit?(commit)
+    def formatter
+      @formatter ||= Formatters.formatter_for(self)
     end
 
-    # @return [<String, String, String>]
-    def comment
-      case ::File.extname(name)
-      when '.rb', '.coffee', '.sass'
-        %w(# # #)
-      when '.js', '.css', '.scss'
-        %w(/* * */)
-      when '.erl'
-        %w(% % %)
-      else
-        raise 'Unknown file type'
-      end
+    def write_copyright!
+      formatter.write_copyright!
     end
   end
 end

data/lib/giteaucrat/formatters/coffee_formatter.rb

@@ -0,0 +1,22 @@
+# coding: utf-8
+
+################################################
+# © Alexander Semyonov, 2013—2013, MIT License #
+# Author: Alexander Semyonov <al@semyonov.us>  #
+################################################
+
+require 'giteaucrat/formatters/ruby_formatter'
+
+module Giteaucrat
+  module Formatters
+    class CoffeeFormatter < RubyFormatter
+      def include_encoding?
+        false
+      end
+
+      def add_copyright!
+        @contents = [format_copyright, contents].join("\n\n")
+      end
+    end
+  end
+end

data/lib/giteaucrat/formatters/formatter.rb

@@ -0,0 +1,126 @@
+# coding: utf-8
+
+################################################
+# © Alexander Semyonov, 2013—2013, MIT License #
+# Author: Alexander Semyonov <al@semyonov.us>  #
+################################################
+
+require 'giteaucrat/formatters'
+require 'delegate'
+
+module Giteaucrat
+  module Formatters
+    class Formatter < SimpleDelegator
+      # @return [String]
+      def format_copyright
+        first, _, last = comment_parts
+        lines = copyright_lines
+
+        max_line_size = lines.max { |a, b| a.size <=> b.size }.size
+        max_line_size += 1 if max_line_size.odd?
+
+        lines = lines.map do |line|
+          blank = ' ' * (max_line_size - line.size) if line.size < max_line_size
+          "#{line}#{blank}"
+        end
+
+        line_width = first.size + 1 + max_line_size + 1 + last.size
+
+        formatted = []
+        formatted << header_ruler(line_width)
+        formatted << lines.map { |line| format_line(line) }
+        formatted << footer_ruler(line_width)
+        formatted.join("\n")
+      end
+
+      def comment_parts
+        self.class.const_get(:COMMENT_PARTS)
+      end
+
+      def header_ruler(line_width)
+        ruler(line_width)
+      end
+
+      def footer_ruler(line_width)
+        ruler(line_width)
+      end
+
+      def ruler(line_width)
+        first, middle, last = comment_parts
+        ruler_width = (line_width - first.size - last.size) / middle.size
+        "#{first}#{middle * ruler_width}#{last}"
+      end
+
+      def format_line(line)
+        "  #{line}  "
+      end
+
+      def remove_copyright!
+        contents.sub!(self.class.const_get(:COPYRIGHT_REGEXP), '')
+        if $~ && $~[:comment]
+          parse_comment($~[:comment])
+        end
+      end
+
+      def parse_comment(comment)
+        @comment_lines = comment.split("\n")
+        @copyright_lines = nil
+      end
+
+      def comment_lines
+        @comment_lines
+      end
+
+      def comment?
+        !!@comment_lines
+      end
+
+      # @return [String]
+      def write_copyright!
+        remove_copyright!
+        add_copyright!
+        write_contents(contents)
+      end
+
+      def add_copyright!
+        @contents = [format_copyright, contents].join("\n\n")
+      end
+
+      private
+
+      def copyright_lines
+        @copyright_lines ||= begin
+          lines = []
+
+          lines << repo.copyright_label
+
+          if owner || authors.size > 0
+            authors_label = (authors.size > 1) ? 'Authors: ' : 'Author: '
+            author_names = (authors - [owner]).map { |a| a.identifier }.sort
+            prepend = ' ' * authors_label.size
+            lines << "#{authors_label}#{owner.identifier}"
+            author_names.each do |author|
+              lines << "#{prepend}#{author}"
+            end
+          end
+
+          if comment?
+            lines << ''
+            lines += comment_lines
+          end
+
+          lines
+        end
+      end
+
+      # @return [Giteaucrat::File]
+      def file
+        __getobj__
+      end
+
+      def contents
+        @contents ||= read_contents
+      end
+    end
+  end
+end

data/lib/giteaucrat/formatters/java_formatter.rb

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+################################################
+# © Alexander Semyonov, 2013—2013, MIT License #
+# Author: Alexander Semyonov <al@semyonov.us>  #
+################################################
+
+require 'giteaucrat/formatters/formatter'
+
+module Giteaucrat
+  module Formatters
+    class JavaFormatter < Formatter
+      COMMENT_PARTS = %w(/* * */)
+
+      COPYRIGHT_REGEXP = %r{/\*(?<ruler>\*+)\n(?<copyrights>(\s\*\s*[^\s\*]+.*\n)+)(\s\*\s*\*?\n(?<comment>(\s\*\s?.*\*?\n)+))?(\s\g<ruler>\**/\n+)}
+
+      def format_line(line)
+        " * #{line} *"
+      end
+
+      def header_ruler(line_width)
+        "/*#{'*' * (line_width - 3)}"
+      end
+
+      def footer_ruler(line_width)
+        " #{'*' * (line_width - 3)}*/"
+      end
+
+      def parse_comment(comment)
+        comment_lines = comment.split("\n").map do |line|
+          line.sub(/\A\s\*\s?/, '').sub(/\s*\*\s*\Z/, '')
+        end
+        @comment_lines = comment_lines
+      end
+    end
+  end
+end

data/lib/giteaucrat/formatters/python_formatter.rb

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+################################################
+# © Alexander Semyonov, 2013—2013, MIT License #
+# Author: Alexander Semyonov <al@semyonov.us>  #
+################################################
+
+require 'giteaucrat/formatters/ruby_formatter'
+
+module Giteaucrat
+  module Formatters
+    class PythonFormatter < RubyFormatter
+    end
+  end
+end

data/lib/giteaucrat/formatters/ruby_formatter.rb

@@ -0,0 +1,58 @@
+# coding: utf-8
+
+################################################
+# © Alexander Semyonov, 2013—2013, MIT License #
+# Author: Alexander Semyonov <al@semyonov.us>  #
+################################################
+
+require 'giteaucrat/formatters/formatter'
+
+module Giteaucrat
+  module Formatters
+    class RubyFormatter < Formatter
+      COMMENT_PARTS = %w(# # #)
+
+      # @return [String]
+      CODING_REGEXP = /\A(#\s*.*coding:\s*utf-8\s*\n+)?/
+      COPYRIGHT_REGEXP = /(?<ruler>##+#\n)(?<copyright>(#\s*[^\s#]+.*\s#\n)+)(#\s+#?\n(?<comment>(#\s*.*#?\n)+))?\k<ruler>\n+/
+
+      def format_copyright
+        copyright = super
+        copyright = "# coding: utf-8\n\n#{copyright}" if include_encoding?
+        copyright
+      end
+
+      def format_line(line)
+        first, _, last = comment_parts
+        "#{first} #{line} #{last}"
+      end
+
+      def remove_copyright!
+        super
+        contents.sub!(CODING_REGEXP, '') if include_encoding?
+      end
+
+      def add_copyright!
+        if !include_encoding? && !!(contents =~ CODING_REGEXP)
+          lines = contents.split(/\n/).to_a
+          lines.insert(1, format_copyright)
+          @contents = lines.join("\n")
+        else
+          super
+        end
+      end
+
+      def parse_comment(comment)
+        middle = Regexp.escape(comment_parts[1])
+        comment_lines = comment.split("\n").map do |line|
+          line.sub(/\A#{middle}\s?/, '').sub(/\s*#{middle}\s*\Z/, '')
+        end
+        @comment_lines = comment_lines
+      end
+
+      def include_encoding?
+        repo.include_encoding?
+      end
+    end
+  end
+end

data/lib/giteaucrat/formatters/sass_formatter.rb

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+################################################
+# © Alexander Semyonov, 2013—2013, MIT License #
+# Author: Alexander Semyonov <al@semyonov.us>  #
+################################################
+
+require 'giteaucrat/formatters/ruby_formatter'
+
+module Giteaucrat
+  module Formatters
+    class SassFormatter < RubyFormatter
+      COMMENT_PARTS = %w(// // //)
+      COPYRIGHT_REGEXP = %r{(?<ruler>//+\n)(?<copyright>(//\s*[^\s/]+.*\s//\n)+)(//\s+//?\n(?<comment>(//\s*.*//?\n)+))?\k<ruler>\n+}
+
+      def include_encoding?
+        false
+      end
+
+      def add_copyright!
+        @contents = [format_copyright, contents].join("\n\n")
+      end
+    end
+  end
+end

data/lib/giteaucrat/formatters.rb

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+################################################
+# © Alexander Semyonov, 2013—2013, MIT License #
+# Author: Alexander Semyonov <al@semyonov.us>  #
+################################################
+
+require 'giteaucrat'
+
+module Giteaucrat
+  module Formatters
+    UnknownFormatError = Class.new(StandardError)
+
+    EXTENSIONS = {
+      '.rb' => :RubyFormatter,
+      '.java' => :JavaFormatter,
+      '.py' => :PythonFormatter,
+      '.sass' => :SassFormatter,
+      '.scss' => :SassFormatter,
+      '.coffee' => :CoffeeFormatter,
+    }
+
+    module_function
+
+    def formatter_for(file)
+      extension = ::File.extname(file.name)
+      formatter = EXTENSIONS[extension]
+      raise(UnknownFormatError, extension) unless formatter
+      const_get(formatter).new(file)
+    end
+  end
+end
+
+require 'giteaucrat/formatters/formatter'
+
+require 'giteaucrat/formatters/coffee_formatter'
+require 'giteaucrat/formatters/java_formatter'
+require 'giteaucrat/formatters/python_formatter'
+require 'giteaucrat/formatters/ruby_formatter'
+require 'giteaucrat/formatters/sass_formatter'

data/lib/giteaucrat/repo.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 ################################################
-# © Alexander Semyonov, 2013—2013              #
+# © Alexander Semyonov, 2013—2013, MIT License #
 # Author: Alexander Semyonov <al@semyonov.us>  #
 ################################################
 
@@ -42,8 +42,8 @@ module Giteaucrat
     def files
       @files ||= begin
         Dir.chdir(path) do
-          %w(app lib script spec).inject([]) do |files, path|
-            files + Dir[::File.join(path, '**/*.rb')]
+          patterns.inject([]) do |files, pattern|
+            files + Dir[pattern]
           end.map do |file_name|
             File.new(name: file_name, repo: self)
           end
@@ -57,6 +57,17 @@ module Giteaucrat
       end
     end
 
+    # @return [<String>]
+    def patterns
+      @patterns || %w(app/**/*.rb lib/**/*.rb script/**/*.rb spec/**/*.rb test/**/*.rb)
+    end
+
+    attr_writer :patterns
+
+    def patterns=(patterns)
+      @patterns = patterns
+    end
+
     def timeout
       Grit::Git.git_timeout
     end

data/lib/giteaucrat/runner.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 ################################################
-# © Alexander Semyonov, 2013—2013              #
+# © Alexander Semyonov, 2013—2013, MIT License #
 # Author: Alexander Semyonov <al@semyonov.us>  #
 ################################################
 
@@ -52,6 +52,11 @@ module Giteaucrat
                  aliases: %w(-c),
                  desc: 'Commit updated copyrights',
                  group: :giteaucrat
+    class_option :patterns,
+                 type: :array,
+                 aliases: %w(-f),
+                 desc: 'Files to copyright',
+                 group: :giteaucrat
 
     desc 'copyrights', 'Update copyright information in files'
 

data/lib/giteaucrat/version.rb

@@ -1,10 +1,10 @@
 # coding: utf-8
 
 ################################################
-# © Alexander Semyonov, 2013—2013              #
+# © Alexander Semyonov, 2013—2013, MIT License #
 # Author: Alexander Semyonov <al@semyonov.us>  #
 ################################################
 
 module Giteaucrat
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/giteaucrat.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 ################################################
-# © Alexander Semyonov, 2013—2013              #
+# © Alexander Semyonov, 2013—2013, MIT License #
 # Author: Alexander Semyonov <al@semyonov.us>  #
 ################################################
 
@@ -11,6 +11,7 @@ module Giteaucrat
   autoload :Author, 'giteaucrat/author'
   autoload :Common, 'giteaucrat/common'
   autoload :File, 'giteaucrat/file'
+  autoload :Formatters, 'giteaucrat/formatters'
   autoload :Repo, 'giteaucrat/repo'
   autoload :Runner, 'giteaucrat/runner'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: giteaucrat
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alexander Semyonov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -77,6 +77,7 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
 - bin/giteaucrat
@@ -87,6 +88,13 @@ files:
 - lib/giteaucrat/author.rb
 - lib/giteaucrat/common.rb
 - lib/giteaucrat/file.rb
+- lib/giteaucrat/formatters.rb
+- lib/giteaucrat/formatters/coffee_formatter.rb
+- lib/giteaucrat/formatters/formatter.rb
+- lib/giteaucrat/formatters/java_formatter.rb
+- lib/giteaucrat/formatters/python_formatter.rb
+- lib/giteaucrat/formatters/ruby_formatter.rb
+- lib/giteaucrat/formatters/sass_formatter.rb
 - lib/giteaucrat/repo.rb
 - lib/giteaucrat/runner.rb
 - lib/giteaucrat/version.rb