enforce 0.0.1

checksums.yaml

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

data/README.md

@@ -0,0 +1,40 @@
+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)
+
+---
+
+Create globally available DSL scripts to verify the existence of files in
+a folder, and the contents of these files.
+
+---
+
+Install
+--------------------------------------------------
+
+```
+$ gem install enforce
+```
+
+Or with bundler:
+
+```ruby
+gem 'enforce'
+```
+
+Example
+--------------------------------------------------
+
+Soon
+
+
+Usage
+--------------------------------------------------
+
+Soon
+

data/bin/enforce

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'enforce'
+exitcode = Enforce::CommandLine.instance.execute ARGV
+exit exitcode
+

data/lib/enforce.rb

@@ -0,0 +1,5 @@
+require 'enforce/version'
+require 'enforce/colors'
+require 'enforce/dsl'
+require 'enforce/handler'
+require 'enforce/command_line'

data/lib/enforce/bin_spec.rb

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

data/lib/enforce/colors.rb

@@ -0,0 +1,16 @@
+module Enforce
+  module Colors
+    def colors
+      {
+        reset:  "\e[0m",  black:  "\e[30m", red:    "\e[31m",
+        green:  "\e[32m", yellow: "\e[33m", blue:   "\e[34m",
+        magenta:"\e[35m", cyan:   "\e[36m", white:  "\e[37m",
+      }
+    end
+
+    def say(message)
+      message.gsub!(/`([^`]+)`/, "%{blue}\\1%{reset}")
+      puts "#{message}%{reset}" % colors
+    end
+  end
+end

data/lib/enforce/command_line.rb

@@ -0,0 +1,55 @@
+require 'singleton'
+
+module Enforce
+  class CommandLine
+    include Singleton
+
+    def execute(argv=[])
+      return show_usage if argv.empty?
+
+      file = find_file argv[0]
+      return show_file_not_found unless file
+
+
+      handler.execute file
+      handler.failed? ? 1 : 0
+    end
+
+    private
+
+    def find_file(basename)
+      candidates = [
+        "#{basename}.rb",
+        "#{home_dir}/#{basename}.rb"
+      ]
+
+      candidates.each do |candidate|
+        return candidate if File.exist? candidate
+      end
+
+      false
+    end
+
+    def handler
+      @handler ||= Enforce::Handler.new
+    end
+
+    def show_usage
+      puts "Enforce #{Enforce::VERSION}"
+      puts "  Usage: enforce RULES_FILE"
+      0
+    end
+
+    def show_file_not_found
+      puts "Error: Could not find rules file"
+      1
+    end
+
+    def home_dir
+      ENV['ENFORCE_HOME'] ||= "#{Dir.home}/enforce"
+    end
+
+  end
+end
+
+

data/lib/enforce/dsl.rb

@@ -0,0 +1,67 @@
+module Enforce
+  class DSL
+    attr_reader :last_file
+
+    def file(name)
+      pass = File.exist?(name)
+      @last_file = name
+
+      add_result message: "File `#{name}` should exist", 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)
+    end
+
+    def folder(name)
+      pass = Dir.exist?(name)
+      add_result message: "Folder `#{name}` should exist", pass: pass
+
+      return unless pass && block_given?
+
+      Dir.chdir name do
+        yield
+      end
+    end
+
+    def with(content)
+      content_as_string = content.is_a?(String) ? content : content.inspect
+      add_result message: "File `#{last_file}` should contain `#{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}`", 
+        pass: !File.read(last_file).match?(content)
+    end
+
+    def results
+      @results ||= []
+    end
+
+    def passed_results
+      results.select { |result| result[:pass] }
+    end
+
+    def failed_results
+      results.reject { |result| result[:pass] }
+    end
+
+    protected
+
+    def add_result(result)
+      results.push result unless results.include? result
+      handle result
+    end
+
+    def handle(result)
+      # Do nothing, should be overridden
+    end
+  end
+end

data/lib/enforce/handler.rb

@@ -0,0 +1,26 @@
+require 'singleton'
+
+module Enforce
+  class Handler < DSL
+    include Colors
+
+    def execute(file)
+      eval File.read file
+      color = failed? ? "%{red}" : "%{green}"
+      say "#{color}#{results.count} rules, #{failed} failures"
+    end
+
+    def failed
+      failed_results.count
+    end
+
+    def failed?
+      failed_results.count > 0
+    end
+
+    def handle(message:, pass:)
+      status = pass ? "%{green}PASS%{reset}" : "%{red}FAIL%{reset}"
+      say "#{status} #{message}"
+    end
+  end
+end

data/lib/enforce/version.rb

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

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: enforce
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: runfile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: runfile-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec_fixtures
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: Define rules for folder and file contents and enforce them from the command
+  line
+email: db@dannyben.com
+executables:
+- enforce
+extensions: []
+extra_rdoc_files: []
+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
+- lib/enforce/handler.rb
+- lib/enforce/version.rb
+homepage: https://github.com/DannyBen/enforce
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: DSL for enforcing folder and file contents
+test_files: []