retrospec 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a32d8bf8211bd6800d235dbf679722352846bb9f
-  data.tar.gz: fa73cfdbc897b537d5c4eccd161b15422bfced6c
+  metadata.gz: 0659917a8ec821253617d285409639b144be2979
+  data.tar.gz: 4a797031adc73b0bdf1a031d5298682f6b08cc47
 SHA512:
-  metadata.gz: 31d396a416975231beef521abe604eccddffdf0406d0d1b837f7b6141f31ce017e7703753ee530238f4d75d48e698e7746b27d981d33a427a69cf0242258c7e1
-  data.tar.gz: 3f9dd3b24dc2c3861e1e22042ef27bcc2c907830fbac7e5ef741803642f22740ce5613acef1d70f2f5c74e26c8c8845d41c772f4427452aef06ac3f688e1a265
+  metadata.gz: 6b0e34a19203df1f8244021fcfda2f9b5ba89465ce2611405cd81ef0c675124a86995eff308680c0da79e1a6d9812106f5bc509600a6b83f1cf0bf1a36658c68
+  data.tar.gz: f6c4d3c7c6457fa5dbc5c6e63cc3d4f7affae20a43daff185bfd154e225a25573b9cd8bd914fddc46679ba7b5015df2683eb98765c11b79edb674ee825383d2c

data/CHANGELOG.md

@@ -1,5 +1,9 @@
+# Retrospec Changelog
+## 0.6.0
+ * Adds the ability to filter out certain files from being generated
+ * Adds the ability to sync any module file when it ends contains a .sync in the file name
 ## 0.5.1
  * fixes gemspec spefication for runtime dependency
 ## 0.5.0
  * adds ability to overwrite files
- * removes jeweler dependency, and uses bundler tasks instead
+ * removes jeweler dependency, and uses bundler tasks instead

data/README.md

@@ -119,6 +119,10 @@ Some ideas I have in my head for future plugins that should be created.
 
 The sky is really the limit for what we can create since the usage is limited to any project that contains files. 
 
+## Special file extensions
+ * If a file contains `.sync` the file will be always be synced
+ * If a file contains `.retrospec.erb` this tells retrospec that the file should be rendered as an erb file
+ 
 ## Contributing to retrospec
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/lib/retrospec/plugins/v1/module_helpers.rb

@@ -83,9 +83,40 @@ module Retrospec
           end
         end
 
+        # @param [String] - destination of the file
+        # @return [Bool] - true if the file should be synced
+        # determines if the file should be synced by checking if the any of the file extensions
+        # have the word sync
+        def sync_file?(file)
+          filename = File.basename(file)
+          parts = filename.split('.')
+          parts.include?('sync')
+        end
+
+        # @param [String] - destination of the file
+        # @return [Bool] - true if the file should be synced
+        # determines if the contains the extension retrospec
+        # have the word sync
+        def retrospec_file?(file)
+          filename = File.basename(file)
+          parts = filename.split('.')
+          parts.include?('retrospec')
+        end
+
+        # @param [String] - destination of the file
+        # @param [Bool] - true if the file should be synced
+        # @return [Bool] - true if the file should be created or overwritten
+        def should_create?(dest, sync_file = false)
+          return true unless File.exists?(dest)
+          return true if sync_file
+          return true if overwrite?(dest)
+          return true if File.zero?(dest)
+          false
+        end
+
         # move the file, safely
         def safe_move_file(src,dest)
-          if File.exists?(dest) && !overwrite?(dest)
+          unless should_create?(dest)
             return $stderr.puts "!! #{dest} already exists and differs from template".warning
           end
           create_content(:mv, dest, src)
@@ -93,15 +124,15 @@ module Retrospec
 
         # copy the symlink and preserve the link
         def safe_create_symlink(src,dest)
-          if File.exists?(dest) && !overwrite?(dest)
+          unless should_create?(dest)
             return $stderr.puts "!! #{dest} already exists and differs from template".warning
           end
           create_content(:link, dest, src)
         end
 
         # safely copy an existing file to another dest
-        def safe_copy_file(src, dest)
-          if File.exists?(dest) and !File.zero?(dest) && !overwrite?(dest)
+        def safe_copy_file(src, dest, sync_file = false)
+          unless should_create?(dest, sync_file)
             return $stderr.puts "!! #{dest} already exists".warning
           end
           return safe_touch(src) unless File.exists?(src)
@@ -121,11 +152,11 @@ module Retrospec
         end
 
         # safely creates a file and does not override the existing file
-        def safe_create_file(dest, content)
-          if File.exists?(dest) && !overwrite?(dest)
+        def safe_create_file(dest, content, sync_file = false)
+          unless should_create?(dest, sync_file)
             old_content = File.read(dest)
             # if we did a better comparison of content we could be smarter about when we create files
-            if old_content != content or not File.zero?(dest)
+            if old_content != content
               $stderr.puts "!! #{dest} already exists and differs from template".warning
             end
           else
@@ -146,17 +177,15 @@ module Retrospec
         # path is the full path of the file to create
         # template is the full path to the template file
         # spec_object is any bindable object which the templates uses for context
-        def safe_create_template_file(path, template, spec_object)
+        def safe_create_template_file(path, template, spec_object, sync_file = false)
           # check to ensure parent directory exists
           file_dir_path = File.expand_path(File.dirname(path))
-          if ! File.exists?(file_dir_path)
-            safe_mkdir(file_dir_path)
-          end
+          safe_mkdir(file_dir_path) unless File.exists?(file_dir_path)
           File.open(template) do |file|
             renderer = ERB.new(file.read, 0, '-')
             content = renderer.result spec_object.get_binding
             dest_path = File.expand_path(path)
-            safe_create_file(dest_path, content)
+            safe_create_file(dest_path, content, sync_file)
           end
         end
 
@@ -165,9 +194,15 @@ module Retrospec
         # strips the erb extension and renders the template to the current module path
         # filenames must named how they would appear in the normal module path.  The directory
         # structure where the file is contained
-        def safe_create_module_files(template_dir, module_path, spec_object)
-          templates = Find.find(File.join(template_dir,'module_files')).sort
+        # @param [String] template directory of where to find templates
+        # @param [String] module_path - path to the module
+        # @param [String] spec_object - the context that is used for template rendering
+        # @param [String] filter - a regex string used to filter out files
+        def safe_create_module_files(template_dir, module_path, spec_object, filter = nil)
+          dir = File.join(template_dir,'module_files')
+          templates = Find.find(dir).sort
           templates.each do |template|
+            next if template =~ filter
             dest = template.gsub(File.join(template_dir,'module_files'), module_path)
             if File.symlink?(template)
               safe_create_symlink(template, dest)
@@ -176,12 +211,15 @@ module Retrospec
             else
               # because some plugins contain erb files themselves any erb file will be copied only
               # so we need to designate which files should be rendered with .retrospec.erb
-              if template =~ /\.retrospec\.erb/
-                # render any file ending in .retrospec_erb as a template
+              # render any file ending in .retrospec_erb as a template
+              sync_file = sync_file?(template)
+              retrospec_file = retrospec_file?(template)
+              dest = dest.gsub(/\.sync/, '') if sync_file
+              if retrospec_file
                 dest = dest.gsub(/\.retrospec\.erb/, '')
-                safe_create_template_file(dest, template, spec_object)
+                safe_create_template_file(dest, template, spec_object, sync_file)
               else
-                safe_copy_file(template, dest)
+                safe_copy_file(template, dest, sync_file)
               end
             end
           end

data/lib/retrospec/version.rb

@@ -1,4 +1,4 @@
 module Retrospec
-    VERSION = '0.5.1'
+    VERSION = '0.6.0'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retrospec
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Corey Osman