enforce 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62c84e4dfbce7b5a0e150a3b25dfc5e7c91b99aebed8eb75dc18ed22dad114a4
-  data.tar.gz: a4677ac19839c3fcd6265f912d448a65b8c58f72d91f84c999dffb8f74f6b54c
+  metadata.gz: a4f0f43d49e308c9c65fb2b0dd8dda636f357158140dcce83c003ba6c19d30f1
+  data.tar.gz: fa414dce653faafb66fb4701250c8de8914dfd4992901aa51156b99c144d68d1
 SHA512:
-  metadata.gz: 53e3ce2334e0ea0572f32e63c4d9f726cd018ea12033277c6a91e29824ba1f0a6e4a8c121f958d4bb424b67af8e62c305634573ffa61bca6656bf4753fbc3c0c
-  data.tar.gz: 53cc87b17ce8110ae060999107c548ad1a23cbdb47d5d11588740745bbbbce97f272c014afe7131fe487dbbb07e2e6db679f1eff15eb640e7399abf3425ad44e
+  metadata.gz: ae03e8d2b4c8d0b60be8522b720c0f64f7bea0766759fb951cf763e192ff000b2fea036f9bb0b739a305ff964ca3e64c9b01908e029c30793425e6a7c73eca0c
+  data.tar.gz: f3ddde5fb021c84b1df97fca4cf0443a3982a3be63f053c2533370eff1bd666450ae265e6745f643a6f372d574cdc25e40a110e44426fd73b5a31e8e39368ff2

data/README.md

@@ -3,7 +3,6 @@ Enforce - A DSL for verifying file/folder content
 
 [![Gem](https://img.shields.io/gem/v/enforce.svg?style=flat-square)](https://rubygems.org/gems/enforce)
 [![Build](https://img.shields.io/travis/DannyBen/enforce/master.svg?style=flat-square)](https://travis-ci.org/DannyBen/enforce)
-[![Dependencies](https://img.shields.io/gemnasium/DannyBen/enforce.svg?style=flat-square)](https://gemnasium.com/DannyBen/enforce)
 [![Maintainability](https://img.shields.io/codeclimate/maintainability/DannyBen/enforce.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/enforce)
 [![Issues](https://img.shields.io/codeclimate/issues/github/DannyBen/enforce.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/enforce)
 
@@ -30,11 +29,69 @@ gem 'enforce'
 Example
 --------------------------------------------------
 
-Soon
+[![asciicast](https://asciinema.org/a/YqUrRMXdUXVGh7KqJpvy5DVBm.png)](https://asciinema.org/a/YqUrRMXdUXVGh7KqJpvy5DVBm)
+
+Also see the [example folder](/example).
 
 
 Usage
 --------------------------------------------------
 
-Soon
+1. Create a rules file containing any of the DSL commands below.
+2. Run `$ enforce <fules file name>` in the directory you want to test 
+   (without the `.rb` extension)
+
+Rules files are ruby scripts that are located either in the current directory
+or in your home directory, under `enforce` subdirectory (~/enforce/*.rb).
+
+If you wish to place your rules files elsewhere, set the `ENFORCE_HOME` 
+environment variable.
+
+DSL
+--------------------------------------------------
+
+### File Commands
+
+Verify that a file exists:
+
+```ruby
+file 'filename'
+```
+
+Verify that a file exists, and has (or doesn't have) some content:
+
+```ruby
+file 'filename' do
+  with 'any content'
+  with /any.regex/
+  without 'other content or regex'
+  with_line 'line to match, leading and trailing spaces are ignored'
+  without_line 'line to make sure is not in the file'
+end
+```
 
+Verify that a file does not exist:
+
+```ruby
+no_file 'filename'
+```
+
+
+### Folder Commands
+
+Verify that a folder exists:
+
+```ruby
+folder 'dirname'
+```
+
+Verify that a folder exists, and run additional validations inside it:
+
+```ruby
+folder 'dirname' do
+  file 'file-inside-dirname'
+  file 'another-file' do
+    with 'some content'
+  end
+end
+```

data/lib/enforce/command_line.rb

@@ -10,7 +10,6 @@ module Enforce
       file = find_file argv[0]
       return show_file_not_found unless file
 
-
       handler.execute file
       handler.failed? ? 1 : 0
     end
@@ -51,5 +50,3 @@ module Enforce
 
   end
 end
-
-

data/lib/enforce/dsl.rb

@@ -6,21 +6,20 @@ module Enforce
       pass = File.exist?(name)
       @last_file = name
 
-      add_result message: "File `#{name}` should exist", pass: pass
+      add_result message: "file `#{name}`", pass: pass
 
       return unless pass
-      
       yield if block_given?
     end
 
     def no_file(name)
-      add_result message: "File `#{name}` should not exist", 
-        pass: !File.exist?(name)
+      pass = !File.exist?(name)
+      add_result message: "no file `#{name}`", pass: pass
     end
 
     def folder(name)
       pass = Dir.exist?(name)
-      add_result message: "Folder `#{name}` should exist", pass: pass
+      add_result message: "folder `#{name}`", pass: pass
 
       return unless pass && block_given?
 
@@ -31,16 +30,26 @@ module Enforce
 
     def with(content)
       content_as_string = content.is_a?(String) ? content : content.inspect
-      add_result message: "File `#{last_file}` should contain `#{content_as_string}`", 
+      add_result message: "with `#{content_as_string}`", 
         pass: File.read(last_file).match?(content)
     end
 
     def without(content)
       content_as_string = content.is_a?(String) ? content : content.inspect
-      add_result message: "File `#{last_file}` should not contain `#{content_as_string}`", 
+      add_result message: "without `#{content_as_string}`", 
         pass: !File.read(last_file).match?(content)
     end
 
+    def with_line(content)
+      add_result message: "with line `#{content}`", 
+        pass: File.readlines(last_file).map(&:strip).include?(content)
+    end
+
+    def without_line(content)
+      add_result message: "without line `#{content}`", 
+        pass: !File.readlines(last_file).map(&:strip).include?(content)
+    end
+
     def results
       @results ||= []
     end

data/lib/enforce/handler.rb

@@ -20,7 +20,7 @@ module Enforce
 
     def handle(message:, pass:)
       status = pass ? "%{green}PASS%{reset}" : "%{red}FAIL%{reset}"
-      say "#{status} #{message}"
+      say "#{status}  #{message}"
     end
   end
 end

data/lib/enforce/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enforce
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -105,7 +105,6 @@ files:
 - README.md
 - bin/enforce
 - lib/enforce.rb
-- lib/enforce/bin_spec.rb
 - lib/enforce/colors.rb
 - lib/enforce/command_line.rb
 - lib/enforce/dsl.rb
@@ -123,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/enforce/bin_spec.rb

@@ -1,4 +0,0 @@
-require 'spec_helper'
-
-describe 'bin/enforce' do
-end