git-semver-cop 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d93939abae0b642d056eddda577cb8b1bb91b6d
+  data.tar.gz: e9946821a38aab84976d21d6568915b052532360
+SHA512:
+  metadata.gz: 66ddb5aed3bdfe0b788d1ea63987ff1a20ee64a097154a724fdde494f544716c1cec93220addd3fe9b2fedf4a88162be457b597ce0135bd13f3b1d9a0a57e5a1
+  data.tar.gz: bab402eab470a92b94cf47da8b55b87b183df81f588fd4b58adc76ea4c7ba6f080d782e5af1885e38355b00268a361ffaff0c7a98c96740fdd69244759644925

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bernardo Farah
+
+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,42 @@
+# GitSemverCop
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'git-semver-cop'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install git-semver-cop
+
+## Usage
+
+```
+git semver-cop init
+# makes a pre-commit hook that enforces semantic versioning
+
+git semver-cop destroy
+# removes said hook
+```
+
+You are prompted before your commit goes through:
+```
+$ git add .
+$ git commit
+Choose a version increment for this commit:
+[patch|minor|major|none]
+$ none
+# Nothing happened
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/berfarah/git-semver-cop.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/git-semver-cop

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require "git-semver-cop/generator"
+GitSemverCop::Generator.start

data/lib/git-semver-cop.rb

@@ -0,0 +1,14 @@
+require "git-semver-cop/semver"
+Dir[File.expand_path("../git-semver-cop/version_files/*", __FILE__)
+   ].each(&method(:require))
+
+# Public method for updating all of our version files
+module GitSemverCop
+  def self.update_version_files
+    GitSemverCop.constants.each do |klass_sym|
+      klass = GitSemverCop.const_get(klass_sym)
+      next unless klass < GitSemverCop::VersionFile
+      klass.exist? && klass.new.update
+    end
+  end
+end

data/lib/git-semver-cop/generator.rb

@@ -0,0 +1,27 @@
+require "thor"
+
+module GitSemverCop
+  # Our generator that creates the commit hook
+  class Generator < Thor
+    include Thor::Actions
+
+    def self.source_root
+      File.expand_path("../../hooks", __FILE__)
+    end
+
+    def self.destination
+      File.expand_path(".git/hooks/pre-commit", Dir.pwd)
+    end
+
+    desc "init", "Generates a pre-commit hook to ensure you update your .semver"
+    def init
+      copy_file "pre-commit", self.class.destination
+      chmod self.class.destination, 0744
+    end
+
+    desc "destroy", "Get rid of pre-commit hook"
+    def destroy
+      remove_file self.class.destination
+    end
+  end
+end

data/lib/git-semver-cop/semver.rb

@@ -0,0 +1,68 @@
+# This is not the best example of "Single responsibility principle", is it?
+module GitSemverCop
+  # Class for modifying and detecting semver
+  class Semver
+    def initialize
+      @semver = `git status -z .semver`.strip
+    end
+
+    def enforce
+      if    none?     then semver_init
+      elsif added?    # Nothing to do
+      elsif modified? then ask_add_changes
+      else  ask_increment
+      end
+    end
+
+    # #
+    # Get user input
+    def ask_add_changes
+      puts ".semver was modified. Add the file to the commit?\n[y|n]"
+      add_to_git if gets.chomp =~ /^y$/i
+    end
+
+    def ask_increment
+      puts "How big of an increment is this?\n[#{inc_opts.join('|')}]"
+      inc = gets.chomp
+      inc_opts.include?(inc) ? semver_inc(inc) : exit(0)
+    end
+
+    # #
+    # Check status of semver file
+    def none?
+      !File.exist?(".semver")
+    end
+
+    def added?
+      @semver =~ /(M|A)  .semver/
+    end
+
+    def modified?
+      @semver =~ /(M|A) .semver/
+    end
+
+    private
+
+      # #
+      # Valid increment options
+      def inc_opts
+        %w(patch minor major none)
+      end
+
+      # #
+      # Command line operations
+      def add_to_git
+        system("git add .semver")
+      end
+
+      def semver_init
+        puts "Creating a new .semver file"
+        system("semver init")
+      end
+
+      def semver_inc(inc)
+        system("semver inc #{inc}")
+        add_to_git
+      end
+  end
+end

data/lib/git-semver-cop/version_files/gemspec.rb

@@ -0,0 +1,15 @@
+require_relative "version_file"
+
+module GitSemverCop
+  # Class for updating Gemspec
+  class Gemspec < VersionFile
+    self.path = Dir["*.gemspec"].first
+
+    private
+
+      def update_version
+        contents.sub!(/(\.version\s+=\s+).+$/,
+                      '\1"' + current_version + '"')
+      end
+  end
+end

data/lib/git-semver-cop/version_files/package_json.rb

@@ -0,0 +1,15 @@
+require_relative "version_file"
+
+module GitSemverCop
+  # Class for updating package.json
+  class PackageJson < VersionFile
+    self.path = "package.json"
+
+    private
+
+      def update_version
+        contents.sub!(/("version"\s*:\s*)(".+?")/,
+                      '\1"' + current_version + '"')
+      end
+  end
+end

data/lib/git-semver-cop/version_files/version_file.rb

@@ -0,0 +1,42 @@
+require "semver"
+
+module GitSemverCop
+  class VersionFile
+    class << self
+      attr_accessor :path
+
+      def exist?
+        File.exist?(path)
+      end
+    end
+
+    def update
+      update_version
+      write_update
+      add_to_git
+    end
+
+    def path
+      self.class.path
+    end
+
+    private
+
+      def contents
+        @contents ||= File.read(path)
+      end
+
+      def current_version
+        SemVer.find.to_s[1..-1]
+      end
+
+      def write_update
+        puts "Changing #{path} version"
+        File.write(path, contents)
+      end
+
+      def add_to_git
+        system "git add #{path}"
+      end
+  end
+end

data/lib/hooks/pre-commit

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require "git-semver-cop"
+
+# Make sure we're not inside of .git
+Dir.chdir("..") if ENV["GIT_DIR"] == "."
+
+# Reopen STDIN for user response
+$stdin.reopen(File.open("/dev/tty", "r"))
+
+# Enforce our semver
+GitSemverCop::Semver.new.enforce
+
+# Update version files (gemspec, package.json)
+GitSemverCop.update_version_files

data/spec/git-semver-cop_spec.rb

@@ -0,0 +1,20 @@
+describe GitSemverCop do
+  subject { GitSemverCop }
+  before do
+    @gemspec = GitSemverCop::Gemspec
+    @package = GitSemverCop::PackageJson
+  end
+
+  describe ".update_version_files" do
+    it "should update only existing files" do
+      # Our project here only has a gemspec
+      expect(@gemspec.exist?).to be true
+      expect(@package.exist?).to be false
+
+      expect_any_instance_of(@gemspec).to receive(:update)
+      expect_any_instance_of(@package).not_to receive(:update)
+
+      subject.update_version_files
+    end
+  end
+end

data/spec/semver_spec.rb

@@ -0,0 +1,66 @@
+describe GitSemverCop::Semver do
+  subject { described_class.new }
+  before do
+    allow_any_instance_of(Kernel).to receive(:puts).and_return("")
+    allow_any_instance_of(Kernel).to receive(:gets).and_return("")
+  end
+
+  describe "#enforce" do
+    before do
+      allow(Kernel).to receive(:`).and_return("")
+    end
+
+    context "when .semver doesn't exist" do
+      it "invokes semver init" do
+        expect(File).to receive(:exist?).and_return(false)
+        expect(subject).to receive(:semver_init)
+        subject.enforce
+      end
+    end
+
+    context "when .semver has been updated and added" do
+      it "does nothing" do
+        expect_any_instance_of(Kernel).to receive(:`).and_return("M  .semver\0")
+        expect(subject.enforce).to be nil
+      end
+    end
+
+    context "when .semver has been modified but not added" do
+      it "asks to add it" do
+        expect_any_instance_of(Kernel).to receive(:`).and_return("M .semver\0")
+        expect(subject).to receive(:ask_add_changes)
+        subject.enforce
+      end
+    end
+
+    context "when .semver exists but was not modified" do
+      it "asks to increment it" do
+        expect_any_instance_of(Kernel).to receive(:`).and_return("")
+        expect(subject).to receive(:ask_increment)
+        subject.enforce
+      end
+    end
+  end
+
+  describe "#ask_add_changes" do
+    it "adds to git if given [y]" do
+      expect_any_instance_of(Kernel).to receive(:gets).and_return("y")
+      expect(subject).to receive(:add_to_git)
+      subject.ask_add_changes
+    end
+  end
+
+  describe "#ask_increment" do
+    it "goes [none] by default" do
+      expect_any_instance_of(Kernel).to receive(:gets).and_return("")
+      expect_any_instance_of(Kernel).to receive(:exit)
+      subject.ask_increment
+    end
+
+    it "passes a given patch to #semver_inc" do
+      expect_any_instance_of(Kernel).to receive(:gets).and_return("patch")
+      expect(subject).to receive(:semver_inc).with("patch")
+      subject.ask_increment
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,101 @@
+require "simplecov"
+$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+SimpleCov.start { add_filter "_spec" }
+require "git-semver-cop"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/version_files/gemspec_spec.rb

@@ -0,0 +1,36 @@
+describe GitSemverCop::Gemspec do
+  subject { described_class.new }
+
+  describe ".path" do
+    it "finds the gemspec file in the directory" do
+      expect(described_class.path).to eq("git-semver-cop.gemspec")
+    end
+  end
+
+  describe ".exist?" do
+    it "checks if the path exists" do
+      expect(described_class).to receive(:path).and_call_original
+      expect(described_class.exist?).to be true
+    end
+  end
+
+  describe "#update" do
+    before do
+      require "tempfile"
+      @tmp = Tempfile.new("example.gemspec")
+      @tmp.write('spec.version = "1.1.0"')
+      @tmp.close
+    end
+    after { @tmp.unlink }
+
+    it "updates the version in the file and adds it to git" do
+      allow(subject).to receive(:path).and_return(@tmp.path)
+      expect_any_instance_of(Kernel).to receive(:system).and_return(true)
+      expect(SemVer).to receive(:find).and_return("v1.1.1")
+
+      subject.update
+
+      expect(File.read(@tmp.path)).to eq('spec.version = "1.1.1"')
+    end
+  end
+end

data/spec/version_files/package_json_spec.rb

@@ -0,0 +1,36 @@
+describe GitSemverCop::PackageJson do
+  subject { described_class.new }
+
+  describe ".path" do
+    it "is package.json" do
+      expect(described_class.path).to eq("package.json")
+    end
+  end
+
+  describe ".exist?" do
+    it "checks if the path exists" do
+      expect(described_class).to receive(:path).and_call_original
+      expect(described_class.exist?).to be false
+    end
+  end
+
+  describe "#update" do
+    before do
+      require "tempfile"
+      @tmp = Tempfile.new("package.json")
+      @tmp.write('{ "name": "My Name", "version": "1.1.0" }')
+      @tmp.close
+    end
+    after { @tmp.unlink }
+
+    it "updates the version in the file and adds it to git" do
+      allow(subject).to receive(:path).and_return(@tmp.path)
+      expect_any_instance_of(Kernel).to receive(:system).and_return(true)
+      expect(SemVer).to receive(:find).and_return("v1.1.1")
+
+      subject.update
+
+      expect(File.read(@tmp.path)).to eq('{ "name": "My Name", "version": "1.1.1" }')
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: git-semver-cop
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Bernardo Farah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: semver2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: A tool that generates a pre-commit hook to enforce updated sematic versioning
+  for each commit.
+email:
+- ber@bernardo.me
+executables:
+- git-semver-cop
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- bin/git-semver-cop
+- lib/git-semver-cop.rb
+- lib/git-semver-cop/generator.rb
+- lib/git-semver-cop/semver.rb
+- lib/git-semver-cop/version_files/gemspec.rb
+- lib/git-semver-cop/version_files/package_json.rb
+- lib/git-semver-cop/version_files/version_file.rb
+- lib/hooks/pre-commit
+- spec/git-semver-cop_spec.rb
+- spec/semver_spec.rb
+- spec/spec_helper.rb
+- spec/version_files/gemspec_spec.rb
+- spec/version_files/package_json_spec.rb
+homepage: https://github.com/berfarah/git-semver-cop
+licenses:
+- MIT
+metadata: {}
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A small gem to enforce semver versioning before commits
+test_files: []
+has_rdoc: