richmond 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe3d2cb81c934c3cfb710affd81ab50331357ff2
-  data.tar.gz: fcdccef945b2ad8d8db0961a668b4f520abf0d8f
+  metadata.gz: 9c38d13d4efc091f68338f2c9cee24b21c4e51d2
+  data.tar.gz: 7c03fc180e6e9957a2bb3296b64854b1fdbf57d1
 SHA512:
-  metadata.gz: 4b12e08234efb1b9c2028e20ca0271509735fbb0c59ba0be91415487838c819734e87ae543f0152e494a499b7efe718e579f1efa1ebe2994ad9410acaf093775
-  data.tar.gz: 1b972cf6666d3f8cd9c389c08d4eb83de34cca9382be74f4e1d2580bef05a7a87ed2fe18dd74f800998446d02ac6c705b04d12fd544e8321662fb23a4a15a986
+  metadata.gz: 92408bd96cc30f5abcbddbdb2e495e3c70cd311ae3d1b15cd54d409c9267c96e4d8aff9adae483ebd2556206a30e7189d5596d5db9d150932a17883fa9898ca7
+  data.tar.gz: bf732a45e67845e1ceae3fbb0fb5101ecf0efbd2b2dafdcddb6ac1263e628282b87681b47a0fb9908182bae1d4cad5f2ca9511a7d6e751b6cdec80e92b84ec42

data/README.md

@@ -57,6 +57,36 @@ Successive blocks targeting the same output file can be written as follows:
 
 Richmond will take any text in the block and insert it into the specified output file.
 
+# Configuration
+
+Richmond will look for a file called .richmond in the root directory you are running against.
+If it finds the .richmond file, it will load it.
+
+You can use the select or reject methods to change which files Richmond will include or exlude
+in it's processing.
+
+    # Richmond doesn't like binary files
+    Richmond.reject do |file|
+      file.match /images/
+    end
+
+    # I only want to parse .rb files
+    Richmond.select do |file|
+      file.match /\.rb$/
+    end
+
+# Release Notes
+
+## 0.3.0
+
+* Richmond was failing on binary files. Richmond can now be configured to ignore
+  or target specific files or directories via a .richmond file found in the root
+  of the directory being processed.
+
+## 0.2.0
+
+Initial public beta release
+
 ## Contributing
 
 1. Fork it ( https://github.com/crmckenzie/richmond/fork )

data/lib/richmond.rb

@@ -1,29 +1,48 @@
-require "richmond/version"
-require 'richmond/logging'
-require 'richmond/scan_result'
-require 'richmond/rtfm'
+dir = File.dirname(File.expand_path(__FILE__))
+search = "#{dir}/**/*.rb"
+Dir.glob(search).each {|file| require file }
+
 require 'find'
 
 module Richmond
 
-  @@find_files_in_dir = lambda do |dir|
-    files = Find.find(dir).to_a
-    files.reject! {|f| File.directory? f}
-    files.reject! {|f| f.split('/').include? '.git' }
-    files
+  @@default_select_blocks = [
+  ]
+
+  @@default_reject_blocks = [
+    lambda {|f| File.directory? f},
+    lambda {|f| f.split('/').include? '.git' }
+  ]
+
+  @@select_blocks = @@default_select_blocks
+  @@reject_blocks = @@default_reject_blocks
+
+  def self.reset_filters
+    @@select_blocks = @@default_select_blocks
+    @@reject_blocks = @@default_reject_blocks
   end
 
-  def self.filter(&block)
-    @@find_files_in_dir = block
+  def self.select_filters
+    @@select_blocks
   end
 
-  def self.find_files_in_dir(dir)
-    @@find_files_in_dir.call dir
+  def self.reject_filters
+    @@reject_blocks
+  end
+
+  def self.select(&block)
+    @@select_blocks.push block
+  end
+
+  def self.reject(&block)
+    @@reject_blocks.push block
   end
 
   def self.generate(dir)
     rtfm = RTFM.new
-    scan = rtfm.scan dir
+    settings = Richmond::ScanSettings.new dir
+
+    scan = rtfm.scan settings 
     rtfm.emit scan.output
   end
 

data/lib/richmond/rtfm.rb

@@ -26,9 +26,9 @@ module Richmond
       File.expand_path smatch
     end
 
-    def scan(dir)
+    def scan(scan_settings)
       logger.info "beginning scan"
-      result = scan_files Richmond.find_files_in_dir dir
+      result = scan_files scan_settings.files 
       logger.info "scan finished"
       result
     end
@@ -43,14 +43,14 @@ module Richmond
         
         lines = File.readlines file
         lines.each_with_index do |line, i|
-          line.encode!('UTF-8', 'UTF-8', :invalid => :replace)
-          #begin
+          #line.encode!('UTF-8', 'UTF-8', :invalid => :replace)
+          begin
             end_recording! line if end_recording? line
             record! line if recording?
             begin_recording! line if begin_recording? line
-          #rescue Exception => error 
-           # logger.debug "error recording line: #{file}: line: #{i}: #{line} => #{error}"
-          #end
+          rescue Exception => error 
+            logger.debug "error recording line: #{file}: line: #{i}: #{line} => #{error}"
+          end
           end
       end
 

data/lib/richmond/scan_settings.rb

@@ -0,0 +1,41 @@
+module Richmond
+  class ScanSettings
+    attr_reader :dir
+
+    def initialize(dir)
+      @dir = File.expand_path dir
+      richmond_file = File.join(@dir, '.richmond')
+
+      Kernel.load richmond_file if File.exists? richmond_file
+    end
+
+    def file_selectors=(value)
+      @file_selectors = value
+    end
+
+    def file_selectors
+      @file_selectors
+    end
+
+    def file_rejectors=(value)
+      @file_rejectors = value
+    end
+
+    def file_rejectors
+      @file_rejectors
+    end
+
+    def files
+      
+      files = Find.find(dir).to_a
+      Richmond.select_filters.each do |block|
+        files.select!(&block)
+      end
+      Richmond.reject_filters.each do |block|
+        files.reject!(&block)
+      end
+      files
+    end
+
+  end
+end

data/lib/richmond/version.rb

@@ -1,3 +1,3 @@
 module Richmond
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/lib/rtfm_spec.rb

@@ -45,7 +45,10 @@ describe Richmond::RTFM do
   end
 
   describe '.rtfm' do
-    let!(:result) { subject.scan dir }
+    let!(:result) { 
+      settings = Richmond::ScanSettings.new dir
+      return subject.scan settings 
+    }
 
     describe 'simple comment block' do
 
@@ -130,7 +133,10 @@ this:
   end
 
   describe '.emit' do
-    let!(:input_result) { subject.scan dir }
+    let!(:input_result) { 
+      settings = Richmond::ScanSettings.new dir
+       return subject.scan settings 
+    }
 
     before(:each) do
       input_result.output.each_pair do |file, lines|

data/spec/lib/scan_settings_spec.rb

@@ -0,0 +1,71 @@
+require_relative '../spec_helper'
+describe Richmond::ScanSettings do
+
+  describe '.new' do
+    it 'expands dir to full path' do
+      settings = Richmond::ScanSettings.new '.'
+      expect(settings.dir).to eq File.expand_path '.' 
+    end
+  end
+
+  describe 'Richmond.select filter' do
+    before(:each) do
+      Richmond.reset_filters
+    end
+    after(:each) do
+      Richmond.reset_filters
+    end
+
+    it 'will grab filters from global context' do
+      Richmond.select { |file|
+        file.match(/scan_settings_spec/)
+      }
+
+      settings = Richmond::ScanSettings.new '.'
+
+      expect(settings.files.size).to eq 1
+      puts settings.files
+      expect(settings.files).to include File.expand_path(__FILE__)
+    end
+  end
+  
+  describe 'Richmond.reject filter' do
+    before(:each) do
+      Richmond.reset_filters
+    end
+    after(:each) do
+      Richmond.reset_filters
+    end
+
+    it 'will grab filters from global context' do
+      Richmond.reject { |file|
+        file.match(/scan_settings_spec/)
+      }
+
+      settings = Richmond::ScanSettings.new '.'
+      expect(settings.files).to_not include File.expand_path(__FILE__)
+    end
+  end
+
+  describe 'when a .richmond file is present' do
+    before(:each) do
+      Richmond.reset_filters
+    end
+    after(:each) do
+      Richmond.reset_filters
+    end
+
+    it 'loads the richmond file' do
+      file = File.expand_path File.join('.', '.richmond')
+      expect(File).to receive(:exists?).with(file)
+        .and_return(true)
+      
+      expect(Kernel).to receive(:load).with(file)
+        .and_return true
+
+      Richmond::ScanSettings.new '.'
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: richmond
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - crmckenzie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,9 +99,11 @@ files:
 - lib/richmond/logging.rb
 - lib/richmond/rtfm.rb
 - lib/richmond/scan_result.rb
+- lib/richmond/scan_settings.rb
 - lib/richmond/version.rb
 - richmond.gemspec
 - spec/lib/rtfm_spec.rb
+- spec/lib/scan_settings_spec.rb
 - spec/spec_helper.rb
 - tasks/rspec.rake
 homepage: ''
@@ -130,4 +132,5 @@ specification_version: 4
 summary: scrap files for content and emit an aggregate file
 test_files:
 - spec/lib/rtfm_spec.rb
+- spec/lib/scan_settings_spec.rb
 - spec/spec_helper.rb