gitmethere 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13f7914789903c66d5f706790b4bb18a396174cc
-  data.tar.gz: 6079f2bc550342a0461f4b97ca0a2ad8b6b1a07f
+  metadata.gz: 1a9e37922446adc92aac3e9d7f4d5757342f7399
+  data.tar.gz: 8d1c993adcd6089e943a82d1879395082a60f491
 SHA512:
-  metadata.gz: b5773eb0f5b5ea6626a2498a58878fc316d875246d4fdfd1c4b5d4668c4f243479333845caac95dc22a63b9961b80f8089a68865c12e5a6eded286beee8f00dc
-  data.tar.gz: 7d2baa766d8e5b50e9a2335c1d7e773b3a2eac7ddd97ced081dd05c2db21543861c1b1cf2691da8eb7de1fd7a80cbe8a05fbb0b66cafafd0d2828d0d7864fc06
+  metadata.gz: d5ad9bcd14a47774e5dcaea24dd11c43912398307794d858485e436e0842e7c4fbd0878e8077c0208891cd54c649b2cfbbeb77033b52033e7084665d278481d7
+  data.tar.gz: d0d3dc30f37f5aa12fec4f21702cbc978116db01245321ca789c8667bcdf57cefd89f8770e840660390cb649641581a13a2de2156dc853fa8f557a5781686adc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/README.md

@@ -26,7 +26,7 @@ setup = {
     This repository demonstrates how merge conflicts occur."
 }
 
-scenario = GitMeThere::Scenario.new(setup['name'], explanation=setup['explanation'])
+scenario = GitMeThere::Scenario.new(name = setup['name'], explanation = setup['explanation'])
 
 scenario.checkout_branch('feature')
 
@@ -60,6 +60,8 @@ scenario.commit('Add line to master branch')
 
 1. Fork it ( https://github.com/loranallensmith/gitmethere/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+3. Write tests for your changes
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Make sure all tests are passing
+7. Create a new Pull Request

data/Rakefile

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

data/gitmethere.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "fakefs", "~> 0.6"
 
   spec.add_runtime_dependency "git", "~> 1.2"
 

data/lib/gitmethere/version.rb

@@ -1,3 +1,3 @@
 module Gitmethere
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/gitmethere.rb

@@ -38,11 +38,13 @@ module GitMeThere
 
     def create_file(name="my-file.md", content="")
       File.open("#{@name}/#{name}", 'w') do | f |
-        f.puts content
+        unless content.empty?
+          f.puts content
+        end
       end
     end
 
-    def append_to_file(name="myfile.md", content="Adding a bit more content")
+    def append_to_file(name="my-file.md", content="Adding a bit more content")
       File.open("#{@name}/#{name}", 'a') do | f |
         f.puts content
       end

data/spec/scenario_spec.rb

@@ -0,0 +1,159 @@
+require 'gitmethere'
+require 'fakefs/spec_helpers'
+
+RSpec.describe GitMeThere::Scenario do
+
+  before(:each) do
+    include FakeFS::SpecHelpers
+    FileUtils.mkdir('spec-temp')
+    FileUtils.cd('spec-temp')
+  end
+
+  describe ".new()" do
+
+    before(:each) do
+      @scenario = GitMeThere::Scenario.new()
+    end
+
+    it "should create a default scenario directory" do
+      expect(File.directory?('my-scenario')).to eq(true)
+    end
+
+    it "should have a README.md file" do
+      expect(File.exist?('my-scenario/README.md')).to eq(true)
+    end
+
+    it "should have an empty readme file" do
+      expect(File.read('my-scenario/README.md')).to be_empty
+    end
+
+  end
+
+  describe ".new(args)" do
+
+    let(:repo) { "named-repo" }
+    let(:content) { "content" }
+
+    before(:each) do
+      @scenario = GitMeThere::Scenario.new(
+        name=repo,
+        explanation=content)
+    end
+
+    it "should create a directory with the specified name" do
+      expect(File.directory?(repo)).to eq(true)
+    end
+
+    it "should have a README.md file" do
+      expect(File.exist?("#{repo}/README.md")).to eq(true)
+    end
+
+    it "should have the specified content in the README.md file" do
+      expect(File.read("#{repo}/README.md")).to eq("#{content}\n")
+    end
+
+  end
+
+  describe ".create_file()" do
+
+    before(:each) do
+      @scenario = GitMeThere::Scenario.new()
+    end
+
+    it "without arguments" do
+      @scenario.create_file()
+      expect(File.exist?("my-scenario/my-file.md")).to eq(true)
+    end
+
+    it "with arguments" do
+      @scenario.create_file(name="named-file.md", content="This is the content.")
+      expect(File.read("my-scenario/named-file.md")).to eq("This is the content.\n")
+    end
+
+  end
+
+  describe ".append_to_file()" do
+
+    before(:each) do
+      @scenario = GitMeThere::Scenario.new()
+      @scenario.create_file()
+    end
+
+    it "without arguments" do
+      @scenario.append_to_file()
+      expect(File.read("my-scenario/my-file.md")).to include("Adding a bit more content")
+    end
+
+    it "with arguments" do
+      @scenario.append_to_file(name="appended-file.md", content="Added some content.")
+      expect(File.read("my-scenario/appended-file.md")).to include("Added some content.")
+    end
+
+  end
+
+  describe '.checkout_branch()' do
+    before(:each) do
+      @scenario = GitMeThere::Scenario.new(
+        name="test-checkout",
+        explanation="testing the checkout command"
+      )
+    end
+
+    it "with new branch" do
+      @scenario.checkout_branch("feature")
+      expect(@scenario.instance_variable_get(:@g).current_branch).to eq("feature")
+    end
+
+    it "with existing branch" do
+      @scenario.instance_variable_get(:@g).branch("test-branch")
+      @scenario.checkout_branch("test-branch")
+      expect(@scenario.instance_variable_get(:@g).current_branch).to eq("test-branch")
+    end
+
+  end
+
+  describe ".stage_changes()" do
+
+    before(:each) do
+      @scenario = GitMeThere::Scenario.new(
+        name = "test-staging",
+        explanation = "Testing the .stage_changes() method"
+      )
+    end
+
+    it "all changes" do
+      @scenario.create_file(
+        name = "test-staging-files.md",
+        content = "Stage this file."
+      )
+      @scenario.stage_changes
+      expect(@scenario.instance_variable_get(:@g).status.added.keys).to include("test-staging-files.md")
+    end
+
+  end
+
+  describe ".commit()" do
+    before(:each) do
+      @scenario = GitMeThere::Scenario.new(
+        name = "test-commit",
+        explanation = "Testing the commit function"
+      )
+    end
+
+    it "with message" do
+      @scenario.create_file(
+        name = "test-commit-file",
+        content = "commit this file."
+      )
+      @scenario.stage_changes
+      @scenario.commit("Testing the commit function")
+      expect(@scenario.instance_variable_get(:@g).log.first.message).to eq("Testing the commit function")
+    end
+  end
+
+  after(:each) do
+    FileUtils.cd('..')
+    FileUtils.rm_rf('spec-temp')
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# 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
+
+  # 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://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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitmethere
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Allen Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -63,6 +91,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -70,6 +99,8 @@ files:
 - gitmethere.gemspec
 - lib/gitmethere.rb
 - lib/gitmethere/version.rb
+- spec/scenario_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/loranallensmith/gitmethere
 licenses:
 - MIT
@@ -94,4 +125,6 @@ rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: A tool for demonstrating Git scenarios
-test_files: []
+test_files:
+- spec/scenario_spec.rb
+- spec/spec_helper.rb