rstub 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44dda35b2036924e4e4d798aa8a3ca55b5dbe929
-  data.tar.gz: 6fd78aa063a60cad82e874cf0707438e09303e8c
+  metadata.gz: a13ff1120aa1b35ea344951de2522d50a45bc7aa
+  data.tar.gz: 8a6c09dd608324da3045365e2248fb745f77238e
 SHA512:
-  metadata.gz: a20122de6d8fd7864763532bfd961d6046ad0a32ce85dcb3744b66d02034af5c931485afeb853246ba0fc800738811cbbc7f84e82824f50b53d30fb30362cbe2
-  data.tar.gz: 55e9ce7005f0667e72d2f1a83e86ae0d4ed6cb6770825d6a12c79da8571543d183cb902af1ac83eb4b45c7f9dfbda6f70297464fafa735687affdba4ec1bafc2
+  metadata.gz: 31e43a4bae4b24445b4c2c5a76bab16b2fe97c92209fb665f61e3bc84e7788686536d6807721a8296ede19fd39a07faaab9a5c123e5a7126ea336727aa02dcb8
+  data.tar.gz: 92d5d4083b05abe79052ad4894d8246bf1e332f6006a85c92ab27b5dce90d9636f15ed3ccf2adc4157295a19babed7344a8eb957f9e5d598c49fa9e3dbcdbb31

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-ruby '2.2.2'
+ruby '2.3.1'
 
 gemspec
 

data/README.md

@@ -7,13 +7,10 @@
 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.
+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:
+Running `rstub homework.rb studentHW` on homework.rb, which has the following code:
 ```ruby
 def add (a, b)
   # add the two input variables
@@ -30,15 +27,13 @@ def add (a, b)
 end
 ```
 
-Any number of files can be provided, and files can be glob patterns like `*/*.rb`.
-The last argument must be the test directory.
+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 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
+$ rstub "rb/*" student-homework # equivalent with glob pattern
 $ tree .
 .
 ├── rb

data/lib/rstub.rb

@@ -14,7 +14,7 @@ class RStub
   end
 
   def start(args = [])
-    fail ArgumentError, 'Not enough arguments' if args.size < 2
+    raise ArgumentError, 'Not enough arguments' if args.size < 2
     parse_args(args)
     make_new_directory_structure
     parse_files
@@ -23,7 +23,7 @@ class RStub
   private
 
   def directory?(directory)
-    !/^\.?\w+$/.match(directory).nil?
+    directory != '*' && /\.\w+$/.match(directory).nil?
   end
 
   # returns a hash with a files key with a value of an array of the files to be
@@ -32,7 +32,7 @@ class RStub
   def parse_args(args)
     self.target = args.pop
     unless directory?(target)
-      fail ArgumentError, 'The last argument needs to be a directory'
+      raise ArgumentError, 'The last argument needs to be a directory'
     end
     self.files = args
   end

data/lib/rstub/file_parser.rb

@@ -1,7 +1,10 @@
 # FileParser goes through a file and writes the contents of it to a target file,
 # but it ignores anything between the delimiters # STUB and # ENDSTUB.
 class FileParser
+  attr_accessor :stub_regex, :end_stub_regex, :stubbing
+
   def stub(target_file, file)
+    determine_delimiters(file)
     File.open(file, 'r') do |readable_file|
       File.open(target_file, 'w') do |target|
         write_text(target, readable_file)
@@ -11,22 +14,34 @@ class FileParser
 
   private
 
-  def start_stubbing?(line, stubbing)
-    return true if /#\s*stub\s*/i.match(line)
-    stubbing
+  def start_stubbing?(line)
+    self.stubbing = true if line.valid_encoding? && stub_regex.match(line)
   end
 
-  def end_stubbing?(line, stubbing)
-    return false if /#\s*endstub\s*/i.match(line)
-    stubbing
+  def end_stubbing?(line)
+    self.stubbing = false if line.valid_encoding? && end_stub_regex.match(line)
   end
 
   def write_text(target, readable_file)
-    stubbing = false
+    self.stubbing = false
     IO.foreach(readable_file) do |line|
-      stubbing = start_stubbing?(line, stubbing)
+      start_stubbing?(line)
       target.puts line unless stubbing
-      stubbing = end_stubbing?(line, stubbing)
+      end_stubbing?(line)
     end
   end
+
+  def determine_delimiters(file)
+    self.stub_regex, self.end_stub_regex = if /\w+\.rb/i =~ file
+                                             [/#\s*stub\s*/i,
+                                              /#\s*endstub\s*/i]
+                                           elsif /\w+\.html/i =~ file
+                                             [/<!--\s+STUB\s+-->/i,
+                                              /<!--\s+ENDSTUB\s+-->/i]
+                                           else
+                                             # will never be matched by anything
+                                             # thereby preserving all text
+                                             [/$a/i, /$a/i]
+                                           end
+  end
 end

data/lib/rstub/path_parser.rb

@@ -1,5 +1,5 @@
-# PathParser parses directory and file paths into a hash with directory and file
-# arrays.
+# PathParser parses directory and file paths into a hash with directory
+# and file arrays.
 class PathParser
   def get_globs(files)
     glob_files = check_globs(files)
@@ -24,18 +24,12 @@ class PathParser
     !%r{\/}.match(file).nil?
   end
 
-  def extract_directories(file)
-    file.split('/').slice(0...-1)
-  end
-
   def get_directories(files)
     dirs = []
     files.each do |file|
       if Dir.exist? file
         dirs << file
         dirs.concat(get_directories(Dir.glob("#{file}/*")))
-      elsif in_directory?(file)
-        dirs << extract_directories(file)
       end
     end
     dirs.flatten.uniq

data/rstub.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = 'rstub'
-  s.version = '0.2.1'
+  s.version = '0.3.1'
 
-  s.date = '2015-05-30'
+  s.date = '2016-08-07'
   s.summary = 'A gem to stub out code'
   s.description = 'A gem to stub out pieces of code'
   s.authors = 'Justin Kim'

data/spec/file_parser_spec.rb

@@ -76,5 +76,21 @@ describe FileParser do
         expect_text('file1.rb', "hello\nfoo\n")
       end
     end
+
+    describe 'can stub html files' do
+      it 'can add text without stubs' do
+        text = "foo\nbar\n"
+        add_text('file1.html.erb', text)
+        stub_all
+        expect_text('file1.html.erb', "foo\nbar\n")
+      end
+
+      it 'doesn\'t include text between stub delimiters' do
+        text = "<!-- STUB -->\n hello <!-- ENDSTUB -->\n"
+        add_text('file1.html.erb', text)
+        stub_all
+        expect_text('file1.html.erb', '')
+      end
+    end
   end
 end

data/spec/path_parser_spec.rb

@@ -1,37 +1,55 @@
 describe PathParser do
   describe '#get_globs' do
-    before :all do
-      Dir.mkdir 'test_dir/nested_dir'
-      File.new 'test_dir/nested_dir/nested_file2.rb', 'w+'
-    end
+    let(:path_parser) { PathParser.new }
 
-    after :all do
-      FileUtils.rm_r 'test_dir/nested_dir' if Dir.exist? 'test_dir/nested_dir'
-    end
+    context 'one nested directory' do
+      before :all do
+        Dir.mkdir 'dir1/nested_dir'
+        File.new 'dir1/nested_dir/nested_file2.rb', 'w+'
+      end
 
-    let(:path_parser) { PathParser.new }
+      after :all do
+        FileUtils.rm_r 'dir1/nested_dir' if Dir.exist? 'dir1/nested_dir'
+      end
 
-    it 'returns the same array when there is no match' do
-      expect(path_parser.get_globs(['file1.rb'])[:files])
-        .to match_array(['file1.rb'])
-    end
+      it 'returns the same array when there is no match' do
+        expect(path_parser.get_globs(['file1.rb'])[:files])
+          .to match_array(['file1.rb'])
+      end
 
-    it 'returns glob matches from current directory' do
-      paths = path_parser.get_globs(['*'])
-      expect(paths[:directories])
-        .to match_array(%w(test_dir nested_dir test_dir/nested_dir))
-      expect(paths[:files])
-        .to match_array(%w(file1.rb file2.rb test_dir/nested_file.rb
-                           test_dir/nested_dir/nested_file2.rb))
+      it 'returns glob matches from current directory' do
+        paths = path_parser.get_globs(['*'])
+        expect(paths[:directories])
+          .to match_array(%w(dir1 dir1/nested_dir))
+        expect(paths[:files])
+          .to match_array(%w(file1.rb file2.rb dir1/nested_file1.rb
+                             dir1/nested_dir/nested_file2.rb))
+      end
     end
 
-    it 'returns glob matches from lowel directory' do
-      paths = path_parser.get_globs(['*/*'])
-      expect(paths[:directories])
-        .to match_array(%w(test_dir nested_dir test_dir/nested_dir))
-      expect(paths[:files])
-        .to match_array(%w(test_dir/nested_file.rb
-                           test_dir/nested_dir/nested_file2.rb))
+    context 'two nested directories' do
+      before :all do
+        Dir.mkdir 'dir1/nested_dir'
+        Dir.mkdir 'dir1/nested_dir/nested_dir2'
+        File.new 'dir1/nested_file1.rb'
+        File.new 'dir1/nested_dir/nested_file2.rb', 'w+'
+        File.new 'dir1/nested_dir/nested_dir2/nested_file3.rb', 'w+'
+      end
+
+      after :all do
+        FileUtils.rm_r 'dir1/nested_dir' if Dir.exist? 'dir1/nested_dir'
+      end
+
+      it 'returns glob matches even with two nested directories' do
+        paths = path_parser.get_globs(['*'])
+        expect(paths[:directories])
+          .to match_array(%w(dir1 dir1/nested_dir dir1/nested_dir/nested_dir2))
+        expect(paths[:files])
+          .to match_array(%w(file1.rb file2.rb
+                             dir1/nested_file1.rb
+                             dir1/nested_dir/nested_file2.rb
+                             dir1/nested_dir/nested_dir2/nested_file3.rb))
+      end
     end
   end
 end

data/spec/rstub_spec.rb

@@ -53,8 +53,8 @@ describe RStub do
       expect(Dir.exist?('target')).to be true
       expect(File.exist?('target/file1.rb')).to be true
       expect(File.exist?('target/file2.rb')).to be true
-      expect(Dir.exist?('target/test_dir')).to be true
-      expect(File.exist?('target/test_dir/nested_file.rb')).to be true
+      expect(Dir.exist?('target/dir1')).to be true
+      expect(File.exist?('target/dir1/nested_file1.rb')).to be true
     end
   end
 end

data/spec/spec_helper.rb

@@ -11,10 +11,11 @@ Dir[File.expand_path('../../lib/rstub/*.rb', __FILE__)].each { |f| require f }
 RSpec.configure do |config|
   config.before :all do
     Dir.chdir('spec/fixtures')
-    Dir.mkdir 'test_dir' unless Dir.exist? 'test_dir'
+    Dir.glob('*').each { |f| FileUtils.rm_r f }
+    Dir.mkdir 'dir1' unless Dir.exist? 'dir1'
     File.new 'file1.rb', 'w+'
     File.new 'file2.rb', 'w+'
-    File.new 'test_dir/nested_file.rb', 'w+'
+    File.new 'dir1/nested_file1.rb', 'w+'
   end
 
   config.after :each do
@@ -22,7 +23,7 @@ RSpec.configure do |config|
   end
 
   config.after :all do
-    FileUtils.rm_r 'test_dir' if Dir.exist? 'test_dir'
+    FileUtils.rm_r 'dir1' if Dir.exist? 'dir1'
     FileUtils.rm_r 'file1.rb'
     FileUtils.rm_r 'file2.rb'
     Dir.chdir('../..')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rstub
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Justin Kim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-30 00:00:00.000000000 Z
+date: 2016-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: A gem to stub out code