rstub 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8609d439a3c4e2956479fd493452b733dd2bd858
-  data.tar.gz: 1bab89c3bfcad9bf350e570b9b247bcacfa10c36
+  metadata.gz: 6b3b5fda95d0ecb11fdee272415143f53b917c3c
+  data.tar.gz: ec0ea820b25d336f7e13fad0f488fa9192bf3552
 SHA512:
-  metadata.gz: 0637a1236d86f0e3f1897f16b0b929e0cd80715e01ab72992ecf619351326b882347a679a7e72457eb4b005caf9b598b097149eed7f4c8ff1f4944b57ea802f2
-  data.tar.gz: b337002c0b5054e93f6c8b5d9ee5b4752c52772aedd8f25fac9e2f188de5929dde6b39e476173d585e783cd1eae3a1126c775b81b1328c1640506130064216a1
+  metadata.gz: 96798ac54e1f6cc7b639033fc91448c0ab217f64ba192b9d27b13fe7bb83d65e006c8a64a2bd6952473ce58fbad7b2a7b0e6269787e33576a059901aff2e0e63
+  data.tar.gz: 2f572420e3b83ee4adf65bbfe724ff9a784a5d9e85c6d0379eb0b49486dbde8aa2294b6ab6b111023f69680c74d60d9ffdbef70ce12faddf396bd31670646302

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+notifications:
+  email: false
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+ruby '2.2.1'
+
+gemspec
+
+group :test do
+  gem 'coveralls'
+  gem 'rspec', '~> 3.2'
+end
+
+group :development do
+  gem 'pry'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 
+
+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,56 @@
+# RStub
+
+[![Build Status](https://travis-ci.org/jusjmkim/rstub.svg?branch=master)](https://travis-ci.org/jusjmkim/rstub)
+[![Coverage Status](https://coveralls.io/repos/jusjmkim/rstub/badge.svg?branch=master)](https://coveralls.io/r/jusjmkim/rstub?branch=master)
+
+## Install
+Run `gem install rstub`
+
+## About
+RStub was created for [CIS 196](http://www.seas.upenn.edu/~cis196/) to generate
+boilerplate homework for students to fill out. It was inspired from the
+[Stubbify](https://github.com/isibner/stubbify) module.
+
+## Usage
+Running `rstub homework.rb studentHW` on homework.rb, which has the following
+code:
+```ruby
+def add (a, b)
+  # add the two input variables
+  # STUB
+  a + b
+  # ENDSTUB
+end
+```
+
+Then, the stubs will be removed.
+```ruby
+def add (a, b)
+  # add the two input variables
+end
+```
+
+Any number of files can be provided, and files can be glob patterns like `*/*.rb`.
+The last argument must be the test directory.
+
+RStub preserves the relative paths of the stubbed files, so `./foo/bar.rb` will
+be copied and stubbed into `./targetDir/foo/bar.rb`.
+
+```
+$ rstub rb/homeworkFile1.rb rb/homeworkFile2.rb rb/util/homeworkUtil.rb student-homework
+$ rstub "rb/**/*.rb" student-homework # equivalent with glob pattern
+$ tree .
+.
+├── rb
+│   ├── homeworkFile1.rb
+│   ├── homeworkFile2.rb
+│   └── util
+│       └── homeworkUtil.rb
+└── student-homework
+    └── rb
+        ├── homeworkFile1.rb
+        ├── homeworkFile2.rb
+        └── util
+            └── homeworkUtil.rb
+```
+

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/rstub

@@ -3,4 +3,4 @@
 require 'rstub'
 
 rstub = RStub.new
-rstub.start
+rstub.start(ARGV)

data/lib/rstub/file_parser.rb

@@ -0,0 +1,30 @@
+class FileParser
+  def stub(target_file, file)
+    File.open(file, 'r') do |readable_file|
+      File.open(target_file, 'w') do |target|
+        write_text(target, readable_file)
+      end
+    end
+  end
+
+  private
+
+  def start_stubbing?(line, stubbing)
+    return true if !!/#\s*stub\s*/i.match(line)
+    stubbing
+  end
+
+  def end_stubbing?(line, stubbing)
+    return false if !!/#\s*endstub\s*/i.match(line)
+    stubbing
+  end
+
+  def write_text(target, readable_file)
+    stubbing = false
+    IO.foreach(readable_file) do |line|
+      stubbing = start_stubbing?(line, stubbing)
+      target.puts line unless stubbing
+      stubbing = end_stubbing?(line, stubbing)
+    end
+  end
+end

data/lib/rstub/path_parser.rb

@@ -0,0 +1,53 @@
+class PathParser
+  def self.directory?(directory)
+    !!/^\.?\w+$/.match(directory)
+  end
+
+  def get_globs(files)
+    glob_files = check_globs(files)
+    directories = get_directories(glob_files)
+    all_files = get_files_from_directory(glob_files, directories)
+    { directories: directories, files: all_files.flatten.uniq }
+  end
+
+  private
+
+  def is_glob?(file)
+    !!/\*/.match(file)
+  end
+
+  def check_globs(files)
+    new_files = []
+    files.each { |file| new_files << (is_glob?(file) ? Dir.glob(file) : file) }
+    new_files.flatten
+  end
+
+  def in_directory?(file)
+    !!/\//.match(file)
+  end
+
+  def parse_files_in_directories(file)
+    file.split('/').slice(0...-1)
+  end
+
+  def parse_out_directories(files)
+    directories = []
+    files.each do |file|
+      directories <<  parse_files_in_directories(file) if in_directory?(file)
+    end
+    directories.flatten
+  end
+
+  def get_directories(files)
+    files.select { |file| PathParser.directory?(file) }
+         .concat(parse_out_directories(files))
+  end
+
+  def get_files_from_directory(files, directories)
+    directories.each do |dir|
+      files.delete(dir)
+      files << Dir.glob("#{dir}/*")
+    end
+    files
+  end
+end

data/lib/rstub.rb

@@ -1,8 +1,60 @@
 class RStub
+  attr_reader :file_parser, :path_parser
+  attr_accessor :target, :files, :directories, :target_files
 
-  def start
-    puts 'hello, world!'
+  def initialize
+    @file_parser = FileParser.new
+    @path_parser = PathParser.new
   end
 
-end
+  def start(raw_args = '')
+    args = raw_args.split(' ')
+    raise 'Not enough arguments' if args.size < 2
+    parse_args(args)
+    make_new_directory_structure
+    parse_files
+  end
+
+  private
+
+  # returns a hash with a files key with a value of an array of the files to be
+  # stubbed and a directory key with the name of the directory to be made as a
+  # string
+  def parse_args(args)
+    self.target = args.pop
+    raise 'The last argument needs to be a directory' unless PathParser.directory?(target)
+    self.files = args
+  end
+
+  def make_target_directory
+    Dir.mkdir(target)
+  end
+
+  def make_new_directories
+    directories.each { |dir| Dir.mkdir("#{target}/#{dir}") unless dir == target }
+  end
 
+  def make_new_files
+    target_files.each { |file| File.new(file, 'w') }
+  end
+
+  def parse_files_and_directories
+    parsed_path = path_parser.get_globs(files)
+    self.files = parsed_path[:files].select { |file| File.exist? file }
+    self.target_files = files.map { |file| "#{target}/#{file}"}
+    self.directories = parsed_path[:directories]
+  end
+
+  def make_new_directory_structure
+    make_target_directory
+    parse_files_and_directories
+    make_new_directories
+    make_new_files
+  end
+
+  def parse_files
+    target_files.each.with_index do |target_file, i|
+      file_parser.stub(target_file, files[i])
+    end
+  end
+end

data/rstub.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name = 'rstub'
+  s.version = '0.1.0'
+
+  s.date = '2015-05-30'
+  s.summary = 'A gem to stub out code'
+  s.description = 'A gem to stub out pieces of code'
+  s.authors = 'Justin Kim'
+  s.email = ['justinjmkim@gmail.com']
+  s.executables = 'rstub'
+  s.homepage = 'https://github.com/jusjmkim/rstub'
+  s.license = 'MIT'
+
+  s.add_development_dependency 'bundler', ['~> 1.8']
+  s.add_development_dependency 'rake', ['~> 10.4']
+  s.files = `git ls-files`.split($ORS)
+  s.test_files = s.files.grep(/^spec/)
+end

data/spec/file_parser_spec.rb

@@ -0,0 +1,90 @@
+describe FileParser do
+  describe '#stub' do
+    before(:all) do
+      Dir.chdir('spec/fixtures')
+    end
+
+    after(:each) do
+      FileUtils.rm_r('target')
+    end
+
+    after(:all) do
+      Dir.chdir('../..')
+    end
+
+    def add_text(text)
+      File.open('foo.rb', 'w') { |f| f.puts text}
+    end
+
+    def stub_all
+      RStub.new.start('* target')
+    end
+
+    def expect_text(text)
+      expect(IO.read('target/foo.rb')).to eql(text)
+    end
+
+    it 'can add text without stubs' do
+      text = "foo\nbar\n"
+      add_text(text)
+      stub_all
+      expect_text("foo\nbar\n")
+    end
+
+    it 'stubs out stub delimiter' do
+      text = "# STUB\n"
+      add_text(text)
+      stub_all
+      expect_text('')
+    end
+
+    it 'preserves text before stub delimiter' do
+      text = "hello\n# STUB\n"
+      add_text(text)
+      stub_all
+      expect_text("hello\n")
+    end
+
+    it 'doesn\'t include endstub delimiter' do
+      text = "# STUB\n# ENDSTUB\n"
+      add_text(text)
+      stub_all
+      expect_text('')
+    end
+
+    it 'doesn\'t include text between stub delimiters' do
+      text = "# STUB\n hello # ENDSTUB\n"
+      add_text(text)
+      stub_all
+      expect_text('')
+    end
+
+    it 'doesn\'t include text after the # STUB' do
+      text = "# STUB\n hello\n"
+      add_text(text)
+      stub_all
+      expect_text('')
+    end
+
+    it 'doesn\'t care about other stub starting delimiters after the first' do
+      text = "# STUB\n hello\n # STUB"
+      add_text(text)
+      stub_all
+      expect_text('')
+    end
+
+    it 'includes plain end stub delimiters' do
+      text = "# ENDSTUB\n"
+      add_text(text)
+      stub_all
+      expect_text("# ENDSTUB\n")
+    end
+
+    it 'resumes putting in text after end delimiter' do
+      text = "hello\n# STUB\nworld\n# ENDSTUB\nfoo\n"
+      add_text(text)
+      stub_all
+      expect_text("hello\nfoo\n")
+    end
+  end
+end

data/spec/fixtures/baz.rb

@@ -0,0 +1 @@
+

data/spec/fixtures/foo.rb

@@ -0,0 +1,5 @@
+hello
+# STUB
+world
+# ENDSTUB
+foo

data/spec/path_parser_spec.rb

@@ -0,0 +1,50 @@
+describe PathParser do
+  before(:all) do
+    Dir.chdir('spec/fixtures')
+  end
+
+  after(:all) do
+    Dir.chdir('../..')
+  end
+
+  describe '::directory?' do
+    it 'no file extension is directory' do
+      expect(PathParser.directory?('bar')).to be true
+    end
+
+    it 'file extension is file' do
+      expect(PathParser.directory?('foo.rb')).to be false
+    end
+
+    it 'detects hidden directories' do
+      expect(PathParser.directory?('.bar')).to be true
+    end
+  end
+
+  describe '#get_globs' do
+    let(:path_parser) { PathParser.new }
+
+    it 'returns the same array when there is no match' do
+      expect(path_parser.get_globs(['foo.rb'])[:files]).to match_array(['foo.rb'])
+    end
+
+    it 'returns glob matches from current directory' do
+      expect(path_parser.get_globs(['*']))
+        .to match_array({ directories: ['foobar'],
+                          files: ['baz.rb', 'foo.rb', 'foobar/foobaz.rb']})
+    end
+
+    it 'adds glob matches to the rest of the files' do
+      expect(path_parser.get_globs(['*', 'foo/bar.rb'])[:directories])
+        .to match_array(['foo', 'foobar'])
+      expect(path_parser.get_globs(['*', 'foo/bar.rb'])[:files])
+        .to match_array(['foo/bar.rb', 'baz.rb', 'foo.rb', 'foobar/foobaz.rb'])
+    end
+
+    it 'returns glob matches from lowel directory' do
+      expect(path_parser.get_globs(['*/*']))
+        .to match_array({ directories: ['foobar'],
+                          files: ['foobar/foobaz.rb'] })
+    end
+  end
+end

data/spec/rstub_spec.rb

@@ -0,0 +1,72 @@
+describe RStub do
+  describe '#start' do
+    before(:all) do
+      Dir.chdir('spec/fixtures')
+    end
+
+    after(:each) do
+      FileUtils.rm_r 'target' if Dir.exist?('target')
+    end
+
+    after(:all) do
+      Dir.chdir('../..')
+    end
+
+    let(:rstub) { RStub.new }
+
+    it 'creates the correct directory and file' do
+      rstub.start('foo.rb target')
+      expect(Dir.exist?('target')).to be true
+      expect(File.exist?('target/foo.rb')).to be true
+    end
+
+    it 'raises error with invalid number of arguments' do
+      expect{rstub.start}.to raise_error('Not enough arguments')
+      expect{rstub.start('foo')}.to raise_error('Not enough arguments')
+    end
+
+    it 'raises error if the last argument isn\'t a directory' do
+      expect{rstub.start('foo.rb baz.rb')}
+        .to raise_error('The last argument needs to be a directory')
+      expect{rstub.start('target foo.rb')}
+        .to raise_error('The last argument needs to be a directory')
+      expect{rstub.start('foo.rb *')}
+        .to raise_error('The last argument needs to be a directory')
+    end
+
+    it 'doesn\'t create files that aren\' already there but were passed in' do
+      rstub.start('bar.rb target')
+      expect(Dir.exist?('target')).to be true
+      expect(File.exist?('target/bar.rb')).to be false
+    end
+
+    it 'adds multiple files to the directory' do
+      rstub.start('foo.rb baz.rb target')
+      expect(Dir.exist?('target')).to be true
+      expect(File.exist?('target/foo.rb')).to be true
+      expect(File.exist?('target/baz.rb')).to be true
+    end
+
+    it 'doesn\'t add nonexistent files even when there are multiple files' do
+      rstub.start('foo.rb bar.rb target')
+      expect(Dir.exist?('target')).to be true
+      expect(File.exist?('target/foo.rb')).to be true
+      expect(File.exist?('target/bar.rb')).to be false
+    end
+
+    it 'doesn\'t add nonexistent files even with wildcard' do
+      rstub.start('foo/* target')
+      expect(Dir.exist?('target')).to be true
+      expect(Dir.exist?('target/foo')).to be false
+    end
+
+    it 'all files are added with wildcard' do
+      rstub.start('* target')
+      expect(Dir.exist?('target')).to be true
+      expect(File.exist?('target/foo.rb')).to be true
+      expect(File.exist?('target/baz.rb')).to be true
+      expect(Dir.exist?('target/foobar')).to be true
+      expect(File.exist?('target/foobar/foobaz.rb')).to be true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler.setup
+
+Bundler.require(:test, :development)
+require 'fileutils'
+Coveralls.wear!
+
+require 'rstub'
+Dir[File.expand_path('../../lib/rstub/*.rb', __FILE__)].each { |f| require f }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rstub
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Justin Kim
@@ -9,7 +9,35 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2015-05-30 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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 gem to stub out pieces of code
 email:
 - justinjmkim@gmail.com
@@ -18,8 +46,25 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
 - bin/rstub
 - lib/rstub.rb
+- lib/rstub/file_parser.rb
+- lib/rstub/path_parser.rb
+- rstub.gemspec
+- spec/file_parser_spec.rb
+- spec/fixtures/baz.rb
+- spec/fixtures/foo.rb
+- spec/fixtures/foobar/foobaz.rb
+- spec/path_parser_spec.rb
+- spec/rstub_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/jusjmkim/rstub
 licenses:
 - MIT
@@ -44,4 +89,11 @@ rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A gem to stub out code
-test_files: []
+test_files:
+- spec/file_parser_spec.rb
+- spec/fixtures/baz.rb
+- spec/fixtures/foo.rb
+- spec/fixtures/foobar/foobaz.rb
+- spec/path_parser_spec.rb
+- spec/rstub_spec.rb
+- spec/spec_helper.rb