github-copywriter 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af87c99fef9a0da582142cf02e362b279b4ecafc
-  data.tar.gz: f7e0a2cfab670d32fe6b65fe9f2d626b96181f6e
+  metadata.gz: c84504ed9a92dd7dcbdd28884905da1fcdeb32a9
+  data.tar.gz: 7e046c94212fbc19527daa8dbf761fca3e772b0b
 SHA512:
-  metadata.gz: 702e4e28d4935802b92ffe5103f34e87e8f6ca2b0bc4fced27fb1ca9d83044842999d04d9b02e3f0a595239dab11ab3af1a26e8211e06d528745be9c7da41643
-  data.tar.gz: a926f723533243eb7f2013c9e7a8c616ed21c3efc6d88ccf02a8ad1f529e21e003a79dc2c1e71cb115da1c8487e14c7afb061e01880d2fd5c46ce7451cd7e8ee
+  metadata.gz: b7a3cdd5d25311fc57aaf0856483dff6dd756d52cb54611aee4f24ec2bfc392026d25f66ac9556cf264475c5d7884bab21a4e7bb2268a2c454e4317dfeac159d
+  data.tar.gz: 2d6ddcfaa1b8c657193845174d22511b4d4a768b146d7986e48bc8e679d397601280f64e231a1c97cd6bf9d2d7347748bb1ffd8febe592bcc5e70e5c3b4077ca

data/CONTRIBUTING.md

@@ -40,6 +40,8 @@ Push changes to the origin.
 git push origin add-rainbow-text
 ```
 
+Lastly, submit a pull request!
+
 ### Staying in sync with the upstream
 Set and fetch the upstream remote.
 ```

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Ryan Jacobs
+Copyright (c) 2015 Ryan Jacobs
 
 MIT License
 

data/README.md

@@ -2,6 +2,10 @@
 [![Build Status](https://travis-ci.org/ryanmjacobs/github-copywriter.svg?branch=master)](https://travis-ci.org/ryanmjacobs/github-copywriter)
 [![Gem Version](https://badge.fury.io/rb/github-copywriter.svg)](http://badge.fury.io/rb/github-copywriter)
 
+![test-repo demo](https://raw.githubusercontent.com/ryanmjacobs/github-copywriter/master/test_repo_demo.gif)
+
+See the commit [here](https://github.com/ryanmjacobs/test-repo/commit/7b095e65adf4cedcd7891326ec32c5f526838dd5).
+
 Updates your copyrights... so you don't have to!
 
 `$ gem install github-copywriter`
@@ -14,7 +18,7 @@ Updates your copyrights... so you don't have to!
 ### Update all repos
 `$ github-copywriter --all`
 
-## Other Usage
+## More Usage
 
 ### Update all repos, excluding forks
 `$ github-copywriter --all --skip-forks`

data/lib/github-copywriter/regex.rb

@@ -26,17 +26,36 @@ class Copywriter
             return false
         end
 
-        # Updates copyright using regex, then commits it.
+        # Updates copyright using regex.
         #
-        # @param year    [Numeric] Year to update to,   e.g. 2024
-        # @param content [String]  Text with outdated copyright
-        # @return [String] Text with updated copyright. Nil if file was already
-        # up to date.
+        # @param year    [String] Year to update to, e.g. "2024"
+        # @param content [String] Text with outdated copyright
+        # @return [String] Hash object {:new_content, :updated_now, :found_copyright}
+        #
+        # Example return hashes:
+        #
+        # Input:
+        #   "...Copyright 2014..."
+        # Return:
+        #   {:content => "...Copyright 2014...", :updated_now => false, :found_copyright => true}
+        #
+        # Input:
+        #   "...no copyright here..."
+        # Return:
+        #   {:content => "...no copyright here...", :updated_now => false, :found_copyright => false}
+        #
+        # Input:
+        #   "...Copyright 2013..."
+        # Return:
+        #   {:content => "...Copyright 2014...", :updated_now => true, :found_copyright => true}
         def update_copyright(year, old_content)
-            # Have to do separate assignments b/c ruby shares strings,
-            # TODO: find a way around this
+            data = {
+                :content => "",
+                :updated_now => false,
+                :found_copyright => false
+            }
 
-            # Do the substitution
+            # The Glorious Regular Expression
             #
             # Matches:
             #     Copyright 2014
@@ -50,21 +69,28 @@ class Copywriter
             #     (c) 2014
             #     (C) 2014
             #     © 2014
+            utf_regex     = /([Cc]opyright( \([Cc]\)| ©)?|\([Cc]\)|©) \d{4}/
+            ascii_regex   = /([Cc]opyright( \([Cc]\))?|\([Cc]\)) \d{4}/
+            regex_replace = "\\1 #{year}"
+
+            # Do the substitution
             begin
-                new_content = \
-                old_content.gsub(/([Cc]opyright( \([Cc]\)| ©)?|\([Cc]\)|©) \d{4}/, "\\1 #{year}")
+                # Do UTF-8 Regex
+
+                data[:found_copyright] = (utf_regex === old_content)
+                data[:content] = old_content.gsub(utf_regex, regex_replace)
             rescue
-                # try w/o "©" symbol if we had errors
-                new_content = \
-                old_content.gsub(/([Cc]opyright( \([Cc]\))?|\([Cc]\)) \d{4}/, "\\1 #{year}")
+                # Do Ascii Regex if the above fails
+                data[:found_copyright] = (ascii_regex === old_content)
+                data[:content] = old_content.gsub(ascii_regex, regex_replace)
             end
 
-            # Only commit if we need to
-            if new_content != old_content then
-                return new_content
-            else
-                return nil
+            # Update whether or not we had to update the copyright
+            if data[:content] != old_content then
+                data[:updated_now] = true
             end
+
+            return data
         end
     end
 end

data/lib/github-copywriter/version.rb

@@ -8,6 +8,6 @@ class Copywriter
 
     # Current version
     # @return [String]
-    VERSION = "1.0.1".freeze
+    VERSION = "1.1.0".freeze
 
 end

data/lib/github-copywriter.rb

@@ -116,9 +116,12 @@ class Copywriter
                         # Update the copyright
                         new_content = Copywriter::Regex.update_copyright(cur_year, Base64.decode64(file[:content]))
 
+                        # Skip to the next file if we didn't even find a copyright in the text
+                        next if not new_content[:found_copyright]
+
                         # Add to list of files to commit, only if the file has changed
-                        if new_content != nil then
-                            @modified_files << {:path => file[:path], :content => new_content}
+                        if new_content[:updated_now] then
+                            @modified_files << {:path => file[:path], :content => new_content[:content]}
                             puts "    #{file[:path]} is now up-to-date.".green
                         else
                             puts "    #{file[:path]} is already up-to-date."
@@ -128,9 +131,13 @@ class Copywriter
 
                 # Commit stored up files
                 if @modified_files.size > 0 then
-                    print "    Committing #{@modified_files.size} files..."
+                    if @modified_files.size == 1 then
+                        print "    Committing 1 file..."
+                    else
+                        print "    Committing #{@modified_files.size} files..."
+                    end
                     commit_files(repo_name, ref, "100644", @modified_files, COMMIT_MSG)
-                    puts " done"
+                    puts " done!"
                 else
                     puts "    No files needed to be commited."
                 end

data/spec/{copyright_spec.rb → copyright_regex_spec.rb}

@@ -23,25 +23,53 @@ copyrights = [
     { :old => "© 1970",             :new => "© 2014" },
 ]
 
+garbage_text = [
+    "sjdfhaksjdfashdjfahskdjfh",
+    "asdjfasdf",
+    "hello these are words",
+    "thing thing thing",
+    "NOTCOPYRIGHT",
+    "NOT COPYRIGHT",
+    "(c) (c) (C)",
+    "_dfasdf_",
+    "© © ©",
+    "REALLYLONGSTRINGWITHNOSPACES"
+]
+
 # ./lib/github-copywriter/regex.rb
 describe Copywriter do
     regex = Copywriter::Regex
 
-    # Copywriter::Regex.update_copyright ->
-    #     should return the updated copyright if the input was out of date
+    # Copywriter::Regex.update_copyright
     context "an out-of-date copyright..." do
         copyrights.each do |copyright|
             updated_copyright = regex.update_copyright(2014, copyright[:old])
-            it { expect(updated_copyright).to eq(copyright[:new]) }
+
+            it { expect(updated_copyright[:updated_now])    .to be(true) }
+            it { expect(updated_copyright[:found_copyright]).to be(true) }
+            it { expect(updated_copyright[:content])        .to eq(copyright[:new]) }
         end
     end
 
-    # Copywriter::Regex.update_copyright ->
-    #     should return nil if the input was up-to-date
+    # Copywriter::Regex.update_copyright
     context "an up-to-date copyright..." do
         copyrights.each do |copyright|
             updated_copyright = regex.update_copyright(2014, copyright[:new])
-            it { expect(updated_copyright).to be(nil) }
+
+            it { expect(updated_copyright[:updated_now])    .to be(false) }
+            it { expect(updated_copyright[:found_copyright]).to be(true) }
+            it { expect(updated_copyright[:content])        .to eq(copyright[:new]) }
+        end
+    end
+
+    # Copywriter::Regex.update_copyright
+    context "garbage text input..." do
+        garbage_text.each do |garbage|
+            updated_copyright = regex.update_copyright(2014, garbage)
+
+            it { expect(updated_copyright[:updated_now])    .to be(false) }
+            it { expect(updated_copyright[:found_copyright]).to be(false) }
+            it { expect(updated_copyright[:content])        .to eq(garbage) }
         end
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-copywriter
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Ryan Jacobs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-17 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,8 +119,9 @@ files:
 - lib/github-copywriter/regex.rb
 - lib/github-copywriter/version.rb
 - spec/accepted_name_spec.rb
-- spec/copyright_spec.rb
+- spec/copyright_regex_spec.rb
 - spec/spec_helper.rb
+- test_repo_demo.gif
 homepage: http://ryanmjacobs.github.io/github-copywriter
 licenses:
 - MIT
@@ -147,5 +148,5 @@ specification_version: 4
 summary: github-copywriter updates your copyrights... so you don't have to!
 test_files:
 - spec/accepted_name_spec.rb
-- spec/copyright_spec.rb
+- spec/copyright_regex_spec.rb
 - spec/spec_helper.rb