github_copier 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f65a16009f22048a6d1efb93d734bd5c936e99ec
-  data.tar.gz: 2d6042100d7705c19166037abd9ada3eee891618
+  metadata.gz: b16b343dbdc33c67dfe9f484926b4d0d3bb38c5e
+  data.tar.gz: ecee64e8b27ffc211e19647028524dcbfaa85431
 SHA512:
-  metadata.gz: b45a11433cf42353184a92da6af9edb0dd983fa8ab88c1f824ab576e3df42f979b2f0d59db98877bffb1db3d1a916fee73c3b7a6f14c28df8bfbe62f7aff034c
-  data.tar.gz: 6c62d3a174b690fadd93d57f0c1928af00ed4031e63d9de9fe426ec6179567aa8bedb9dda55a38e9656276431eeb873d2dbea4eb812293a4c60dbdd1c700cf5d
+  metadata.gz: 3b33a8e35bae65110d8c50bcc9eeeea95a51e5424377a37b5a5800c0a08545d37e90d70d2e042312f9aa36ab71112ebf9d84492cd094fd0aaab2c21c9e842c6a
+  data.tar.gz: 5533a912dd20f3ad557bcc7654b91e5dc49f9919d086a0cdf71dffb021c13349630a455db5f66cf457af738da1bb3017537cec300581e885466911273e70e83b

data/CHANGELOG.md

@@ -5,7 +5,12 @@
 - Initial release
 
 #### 0.2.0
+
 - Add option to group output by language by default
 - Show list of repositories in the dry-run mode (--no-clone) option
 - Improve the gemspec to add more context for the user
 - Add some example to default option when the user type no argument
+
+#### 0.2.1
+
+- Remove the need from `filename_cleaner` and use it locally

data/README.md

@@ -179,7 +179,6 @@ Process 1 of 1 : git clone git@github.com:littlebee/got.git /Users/bchoomnuan/De
 
 - Replace system call with the ruby library like [grit](https://github.com/mojombo/grit) or something similar
 - Allow the `https` when performing the clone
-- Implement the `FilenameCleaner.sanitize()` locally
 
 ### Related Projects
 

data/github_copier.gemspec

@@ -28,7 +28,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'github_api', '~> 0.13'
-  spec.add_runtime_dependency 'filename_cleaner', '~> 0.4'
 
   spec.add_development_dependency 'awesome_print', '~> 1.6'
   spec.add_development_dependency 'bundler', '~> 1.10'

data/lib/github_copier.rb

@@ -1,6 +1,6 @@
 require 'github_copier/version'
 require 'github_copier/opt_parser'
 require 'github_copier/github_copier'
+require 'github_copier/filename_cleaner'
 require 'github_api'
-require 'filename_cleaner'
 include GithubCopier

data/lib/github_copier/filename_cleaner.rb

@@ -0,0 +1,98 @@
+module FilenameCleaner
+  DOT = "."
+  class << self
+    # Sanitize the any name with or without extension
+    #
+    # @param [String] name the input string
+    # @param [String] sep_char the separator char to be used
+    # @param [Boolean] have_extension indicate if the the input file should be
+    #                  treated as having extension or not having one
+    # @return [String] output string with special chars replaced withe specified string
+    def sanitize(name, sep_char = ".", have_extension = false)
+      if have_extension
+        sanitize_name_with_extension(name, sep_char)
+      else
+        sanitize_name_without_extension(name, sep_char)
+      end
+    end
+
+    # Get formatted name for existing file
+    #
+    # @param [String] filename the input filename
+    # @param [Hash<Symbol, Object>] opts the hash value for options to be applied
+    #
+    # @option opts [String]  :sep_char The separator string
+    # @option opts [Boolean] :downcase Convert each word to lower case
+    # @option opts [Boolean] :capitalize: Capitalize each word in the name
+    def formatted_name(filename, opts = {})
+      sep_char = opts[:sep_char] || "."
+      sanitized_name = FilenameCleaner.sanitize(filename, sep_char, true)
+
+      # First split the two part so that only name is used!
+      basename = File.basename(sanitized_name, ".*")
+      extname  = File.extname(sanitized_name)
+      if opts[:downcase]
+        basename = basename.split(sep_char).map(&:downcase).join(sep_char)
+      end
+      if opts[:capitalize]
+        basename = basename.split(sep_char).map(&:capitalize).join(sep_char)
+      end
+      "#{basename}#{extname}"
+    end
+
+  private
+
+    # Sanitize the any name with or without any extension
+    #
+    # @param [String] name the input string
+    # @param [String] sep_char the separator char to be used
+    # @return [String] output string with special chars replaced withe specified string
+    def sanitize_name_without_extension(name, sep_char = ".")
+      replace_dot(sanitize_with_dot(name), sep_char)
+    end
+
+    # Sanitize filename that works with file with extension
+    #
+    # @param [String] name the input filename with extension
+    # @return [String] the output file with special characters replaced
+    def sanitize_name_with_extension(name, sep_char = ".")
+      extension = File.extname(name)
+      name_only = File.basename(name, ".*")
+      name_only = replace_dot(sanitize_with_dot(name_only), sep_char)
+      "#{name_only}#{extension}"
+    end
+
+    # Replace the multiple special characters with a dot string
+    #
+    # @param [String] input_name input file
+    # @return [String] the new name with special characters replaced or removed.
+    def sanitize_with_dot(input_name)
+      # Don't mutate the input name
+      name = input_name.clone
+
+      # Replace any special characters with a dot
+      name.gsub!(/[^0-9A-Za-z\-_ ]/, DOT)
+
+      # Replace multiple occurrences of a given character with a dot
+      ["-", "_", " "].each do |c|
+        name.gsub!(/#{Regexp.quote(c)}+/, DOT)
+      end
+
+      # Replace multiple occurrence of dot with one dot
+      name.gsub!(/#{Regexp.quote(DOT)}+/, DOT)
+
+      # Remove the last char if it is a dot
+      name.gsub!(/\.$/, "") if name[-1] == DOT
+
+      # return the result
+      name
+    end
+
+    # Replace 'dot' string with a given string if specified
+    def replace_dot(string, replace = nil)
+      result = string.clone
+      result.gsub!(/#{Regexp.quote(DOT)}+/, replace) if replace
+      result
+    end
+  end
+end

data/lib/github_copier/version.rb

@@ -1,3 +1,3 @@
 module GithubCopier
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_copier
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-02 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
-- !ruby/object:Gem::Dependency
-  name: filename_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +212,7 @@ files:
 - bin/github_copier
 - github_copier.gemspec
 - lib/github_copier.rb
+- lib/github_copier/filename_cleaner.rb
 - lib/github_copier/github_copier.rb
 - lib/github_copier/opt_parser.rb
 - lib/github_copier/version.rb