timewizard 0.3.0.pre.alpha.pre.53 → 0.3.0.pre.alpha.pre.54

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGVmYWJiOGIyMmM0NDVhNDA0ZWE5YzhlYmEwYTM0YzE5ZDUzYWE5Zg==
+    NTY5NWMwOTczMjFhNjc5NTQ4ZjFjZGY0MjhhYWM5NmQ4ZGMyYzNjNw==
   data.tar.gz: !binary |-
-    MzIwMDczOTc1ZGQ4OTM1Mzg2NGRlMmRhMzg2YzExNDA0YzIyMzE0Yg==
+    OGIxZmI5ZGM0ZjRkYTYxMTJkNTBlZjIyZjA2NzYxYTBmZTExODVhNA==
 SHA512:
   metadata.gz: !binary |-
-    ZWQ0NjU3ZTQyMGU4MDljNGNlOGMxNTY0NTIwZjlkZTNjNDQyNGFjOGUwYWIw
-    ZDI5ZjAzMzhlYjM2ZDUyYTM4NGZjZjhjMWYwMzQxZGQ5ODgyN2M2YTcyNjc4
-    MDMwYWNhZTljZTYwYmNkNzUwOWVkZmM3ZDU5Nzg4OWVlMjdmNGM=
+    YjM4ZGRiZmFiNTQxNGU5NGY5NjUyNGFjNDA5MzVhZmI2YWEyOWVlNWZmMTY5
+    MTViMzVmNWZhNDJlNDJhNjkxYzA0YzUxNGUyYjk0NWE4MjNhODUxZWVlMzll
+    NjRjNTdjZjk5YTBiYjcxYWVmYjU4ZDA4ZGZiYmIwY2Q2M2JjZmQ=
   data.tar.gz: !binary |-
-    MGM2M2Y3NWRjNjQyZDU4NDU5NmMwNDllYWYxMzk1ODI4YjIxZTMzNjBjNmZk
-    NjA0NDdjNmE2NTYxODVkZjA1Mjc1ZmQ1ODBhNDQwNDNkZmZmM2EwOGM5ZGNl
-    MTIwMjExOTlhOGI0OGMwNmJhNGRjYjkxMDA2YTIwM2QyNzNmYjY=
+    YzkxZDk1NDNkYjU5NzMyZTQ3ZDYzMWM0NWE5NmQwMGMxMGQwYWZmYmFlNmYz
+    ZWJjZDA4ZGI4ODBiN2FjODFhOGQ5NDRjZmZjYjRkY2Q1OGQ2MTA5YTc2NzE4
+    ZmE4MjllMDMxZjc5MGY1MTEwMjgzZGUxZGQ3YTEwNzM5MjhlZjQ=

data/.yardopts

@@ -1 +1 @@
---markup rdoc --title "timewizard Documentation" --protected
+--markup markdown --title "timewizard Documentation" --protected

data/Rakefile

@@ -46,24 +46,6 @@ require 'yard'
 YARD::Rake::YardocTask.new
 task :doc => :yard
 
-desc "Adds copyright headers to source/spec files."
-task :headers do
-  require 'copyright_header'
-
-  args = {
-      :license => 'MIT',
-      :copyright_software => 'timewizard',
-      :copyright_software_description => 'A Ruby library for manipulating iOS and Android version numbers.',
-      :copyright_holders => ['Richard Harrah <topplethenunnery@gmail.com>'],
-      :copyright_years => ['2015'],
-      :add_path => 'lib/:spec/',
-      :output_dir => '.'
-  }
-
-  command_line = CopyrightHeader::CommandLine.new args
-  command_line.execute
-end
-
 task :abide => :build do
   require 'abide'
 

data/gemspec.yml

@@ -13,7 +13,6 @@ development_dependencies:
   yard: ~> 0.8.7.6
   codeclimate-test-reporter: ~> 0.4
   abide: ~> 0.0.3
-  copyright-header: ~> 1.0
 
 dependencies:
   versionomy: ~> 0.4

data/lib/timewizard/utils/wizardry.rb

@@ -1,34 +1,23 @@
-#
-# Copyright (C) 2015 Richard Harrah <topplethenunnery@gmail.com>
-#
-# 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.
-#
 module Timewizard
+  # Contains all utility modules and classes.
+  # @since 0.2.4
   module Utils
+    # Contains utility functions in a cleverly named module.
+    # @author Richard Harrah
+    # @since 0.2.4
     module Wizardry
 
       VERSION_REGEX = /((\d+\.)?(\d+\.)?(\*|\d+))(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$/
 
+      # Returns a substring of the passed-in value that matches {Timewizard::Utils::Wizardry::VERSION_REGEX the version regex}.
+      # @param [String] stringy string from which to extract version string
+      # @return [String] substring that matches {Timewizard::Utils::Wizardry::VERSION_REGEX the version regex}
+      # @raise [ArgumentError] if stringy is null
       def self.only_version(stringy)
         if stringy.nil?
-          raise "stringy cannot be null"
+          raise ArgumentError, "stringy cannot be null"
         end
-        VERSION_REGEX.match(stringy).to_s
+        VERSION_REGEX.match(stringy.to_s).to_s
       end
 
     end

data/lib/timewizard/version.rb

@@ -1,23 +1,6 @@
-#
-# Copyright (C) 2015 Richard Harrah <topplethenunnery@gmail.com>
-#
-# 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.
-#
+# It's time-y wime-y and wibbly wobbley. Abracadabra.
+# @author Richard Harrah
+# @since 0.0.1
 module Timewizard
   VERSION = "0.3.0"
 end

data/lib/timewizard/versioner/android.rb

@@ -1,23 +1,3 @@
-#
-# Copyright (C) 2015 Richard Harrah <topplethenunnery@gmail.com>
-#
-# 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.
-#
 require 'timewizard/versioner'
 require 'timewizard/utils/wizardry'
 

data/lib/timewizard/versioner/apple.rb

@@ -1,23 +1,3 @@
-#
-# Copyright (C) 2015 Richard Harrah <topplethenunnery@gmail.com>
-#
-# 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.
-#
 require 'xcodeproj'
 require 'versionomy'
 require 'timewizard/versioner'

data/lib/timewizard/versioner.rb

@@ -1,30 +1,27 @@
-#
-# Copyright (C) 2015 Richard Harrah <topplethenunnery@gmail.com>
-#
-# 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.
-#
 module Timewizard
+  # Contains the various OS implementations of the RubyGem version spec.
+  # @author Richard Harrah
+  # @since 0.1.0
   module Versioner
+    # Represents the most basic of versioners. Raises errors if attempted to be used.
+    # @abstract
+    # @author Richard Harrah
+    # @since 0.2.4
     class Base
+
+      # File that is going to be parsed.
       attr_reader :file
+
+      # Build number currently contained in the parsed file.
       attr_reader :old_build_number
+
+      # Version number currently contained in the parsed file.
       attr_reader :old_version_number
+
+      # Build number to write to the parsed file.
       attr_accessor :new_build_number
+
+      # Version number to write to the parsed file.
       attr_accessor :new_version_number
 
       def initialize(path_to_file)
@@ -34,20 +31,28 @@ module Timewizard
         @file = path_to_file
       end
 
-      def read_build_numbers()
-        # do nothing
+      # Reads the build numbers from {file}.
+      # @raise NotImplementedError, method is not implemented in this class
+      def read_build_numbers
+        raise NotImplementedError
       end
 
-      def read_version_numbers()
-        # do nothing
+      # Reads the version numbers from {file}.
+      # @raise NotImplementedError, method is not implemented in this class
+      def read_version_numbers
+        raise NotImplementedError
       end
 
-      def write_build_numbers()
-        # do nothing
+      # Writes the build numbers to {file}.
+      # @raise NotImplementedError, method is not implemented in this class
+      def write_build_numbers
+        raise NotImplementedError
       end
 
-      def write_version_numbers()
-        # do nothing
+      # Writes the build numbers to {file}.
+      # @raise NotImplementedError, method is not implemented in this class
+      def write_version_numbers
+        raise NotImplementedError
       end
 
     end

data/lib/timewizard.rb

@@ -1,21 +1 @@
-#
-# Copyright (C) 2015 Richard Harrah <topplethenunnery@gmail.com>
-#
-# 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.
-#
 require 'timewizard/version'

data/spec/versioner_spec.rb

@@ -65,42 +65,26 @@ RSpec.describe 'Timewizard::Versioner::Base' do
   end
 
   context '#read_build_numbers' do
-    it 'should not change instance variables' do
-      expect(@versioner.old_build_number).to be_nil
-      expect(@versioner.new_build_number).to be_nil
-      @versioner.read_build_numbers
-      expect(@versioner.old_build_number).to be_nil
-      expect(@versioner.new_build_number).to be_nil
+    it 'should not be implemented' do
+      expect { @versioner.read_build_numbers }.to raise_error(NotImplementedError)
     end
   end
 
   context '#read_version_numbers' do
-    it 'should not change instance variables' do
-      expect(@versioner.old_version_number).to be_nil
-      expect(@versioner.new_version_number).to be_nil
-      @versioner.read_version_numbers
-      expect(@versioner.old_version_number).to be_nil
-      expect(@versioner.new_version_number).to be_nil
+    it 'should not be implemented' do
+      expect { @versioner.read_version_numbers }.to raise_error(NotImplementedError)
     end
   end
 
   context '#write_build_numbers' do
-    it 'should not change instance variables' do
-      expect(@versioner.old_build_number).to be_nil
-      expect(@versioner.new_build_number).to be_nil
-      @versioner.write_build_numbers
-      expect(@versioner.old_build_number).to be_nil
-      expect(@versioner.new_build_number).to be_nil
+    it 'should not be implemented' do
+      expect { @versioner.write_build_numbers }.to raise_error(NotImplementedError)
     end
   end
 
   context '#write_version_numbers' do
-    it 'should not change instance variables' do
-      expect(@versioner.old_version_number).to be_nil
-      expect(@versioner.new_version_number).to be_nil
-      @versioner.write_version_numbers
-      expect(@versioner.old_version_number).to be_nil
-      expect(@versioner.new_version_number).to be_nil
+    it 'should not be implemented' do
+      expect { @versioner.write_version_numbers }.to raise_error(NotImplementedError)
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timewizard
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre.alpha.pre.53
+  version: 0.3.0.pre.alpha.pre.54
 platform: ruby
 authors:
 - Richard Harrah
@@ -122,20 +122,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.3
-- !ruby/object:Gem::Dependency
-  name: copyright-header
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: Uses the RubyGems style of versioning in order to ease updates.
 email: topplethenunnery@gmail.com
 executables: []