schoolmaster 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a043a75aa06e9f71ded6c47b316097a1873d909a
+  data.tar.gz: d31f34e033cf8d6b150ab678070028849ba91351
+SHA512:
+  metadata.gz: 22aead6a0807d70be8b204e62cacf5de11f71b497cb328df23c42527f93d9cb97819bc62cf5df7917358b460af6c8f2ca135966da29d02683d68fd6eef38714e
+  data.tar.gz: 0bb6c6151cda7338ecee8c8e7e2f95dace60e2bfe339705cc0a9c4931731b749b8d7529e31129e929a74937b4d2258f3172c940764a3a23c7791ae429059fa6b

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in schoolmaster.gemspec
+gemspec
+

data/LICENSE

@@ -0,0 +1,340 @@
+GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    {description}
+    Copyright (C) {year}  {fullname}
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  {signature of Ty Coon}, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
+

data/README.md

@@ -0,0 +1,68 @@
+# Schoolmaster
+
+I built schoolmaster as a rake task originally to run a few of my favourite code metrix gems.
+The rake task helped my apprentices check their work before submitting a pullrequest for QA.
+
+The gem currently runs the following checks:
+
+- https://github.com/presidentbeef/brakeman
+- https://github.com/railsbp/rails_best_practices
+- https://github.com/square/cane
+- Schoolmaster currently runs Rspec, this is going to be configurable in the next release.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "schoolmaster"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install schoolmaster
+
+## Usage
+
+To run:
+
+    schoolmaster
+
+Available configuration options:
+
+| Command Options                 | Description									  | Default       |
+| -------------                   | -------------------------		              | ------------- |
+| git_logger (currently disabled) | Where to log git messages			          | nil           |
+| characters_per_line             | Allowed characters per line                   | 100           |
+| require_file_comments           | Require comments at the top of all files      | false         |
+| debug                           | Enables debug model on all gems               | false         |
+| cane_custom_args                | Add additional params to Cane                 | []            |
+| test_custom_args                | Add additional params for rspec               | []            |
+| best_practices_custom_args      | Add additional params to Rails Best Practice  | []            |
+| brakeman_custom_args            | Add additional params to Brakeman             | []            |
+
+### Example configuration block
+
+To customize schoolmaster add an initializer:
+
+    # config/initializers/schoolmaster.rb
+    if defined?(Schoolmaster)
+     Schoolmaster.configure do |c|
+      c.characters_per_line = 200
+      c.cane_custom_args = ["--no-abc", "--no-style"]
+      c.test_custom_args = ["-f doc"]
+      c.best_practices_custom_args = ["--with-git"]
+      c.brakeman_custom_args = ["--skip-files app/controllers/application_controller.rb"]
+     end
+    end
+
+## Contributing
+
+1. Fork it ( http://github.com/alex-handley/schoolmaster/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Ensure the tests pass
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/schoolmaster

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "#{Dir.pwd}/config/environment"
+require "schoolmaster"
+
+Schoolmaster::SuiteRunner.run
+

data/lib/schoolmaster/analysers/base_analyser.rb

@@ -0,0 +1,19 @@
+module Schoolmaster
+	class BaseAnalyser
+		attr_reader :command, :args
+
+		def initialize(params)
+			@command = params.fetch(:command, "")
+			@args = params.fetch(:args, [])
+		end
+
+		def run
+			arg_str = (args | default_args).join(" ")
+			system("#{command} #{arg_str}")
+		end
+
+		def default_args
+			[]
+		end
+	end
+end

data/lib/schoolmaster/analysers/best_practices_analyser.rb

@@ -0,0 +1,9 @@
+module Schoolmaster
+  class BestPracticesAnalyser < BaseAnalyser
+
+  	def initialize(params = {})
+  		super
+  		@command = "rails_best_practices ." if command.empty?
+  	end
+  end
+end

data/lib/schoolmaster/analysers/brakeman_analyser.rb

@@ -0,0 +1,19 @@
+module Schoolmaster
+	class BrakemanAnalyser < BaseAnalyser
+
+		def initialize(params = {})
+			super
+			@command = "brakeman ." if command.empty?
+		end
+
+		def default_args
+			brakeman_opts = []
+
+			unless Schoolmaster.configuration.debug
+				brakeman_opts << "-q"
+			end
+
+			brakeman_opts
+		end
+	end
+end

data/lib/schoolmaster/analysers/cane_analyser.rb

@@ -0,0 +1,21 @@
+module Schoolmaster
+	class CaneAnalyser < BaseAnalyser
+
+		def initialize(params = {})
+			super
+			@command = "cane ." if command.empty?
+		end
+
+		def default_args
+			cane_opts = []
+			cane_opts << "--style-measure " \
+									 "#{Schoolmaster.configuration.characters_per_line}"
+
+			unless Schoolmaster.configuration.require_file_comments
+				cane_opts << " --no-doc"
+			end
+
+			cane_opts
+		end
+	end
+end

data/lib/schoolmaster/analysers/test_analyser.rb

@@ -0,0 +1,9 @@
+module Schoolmaster
+  class TestAnalyser < BaseAnalyser
+
+  	def initialize(params = {})
+  		super
+  		@command = "bundle exec rspec spec" if command.empty?
+  	end
+  end
+end

data/lib/schoolmaster/configuration.rb

@@ -0,0 +1,20 @@
+module Schoolmaster
+	class Configuration
+		attr_accessor :require_file_comments, :debug, :git_logger, :characters_per_line,
+									:cane_custom_args, :best_practices_custom_args, :test_custom_args,
+									:brakeman_custom_args
+
+		def initialize
+			@require_file_comments = false
+			@debug = false
+			@git_logger = nil
+			@characters_per_line = 100
+
+			@cane_custom_args = []
+			@best_practices_custom_args = []
+			@test_custom_args = []
+			@brakeman_custom_args = []
+		end
+	end
+end
+

data/lib/schoolmaster/suite_runner.rb

@@ -0,0 +1,20 @@
+module Schoolmaster
+	class SuiteRunner
+		def self.run
+			Schoolmaster::CaneAnalyser.new(
+																	args: Schoolmaster.configuration.cane_custom_args).run
+
+			if defined?(Rails)
+				Schoolmaster::BestPracticesAnalyser.new(
+												args: Schoolmaster.configuration.best_practices_custom_args).run
+			end
+
+			Schoolmaster::BrakemanAnalyser.new(
+															args: Schoolmaster.configuration.brakeman_custom_args).run
+
+			Schoolmaster::TestAnalyser.new(
+																	args: Schoolmaster.configuration.test_custom_args).run
+		end
+	end
+end
+

data/lib/schoolmaster/version.rb

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

data/lib/schoolmaster.rb

@@ -0,0 +1,17 @@
+require "schoolmaster/version"
+require "schoolmaster/configuration"
+require "schoolmaster/suite_runner"
+
+Dir[File.dirname(__FILE__) + '/schoolmaster/analysers/*.rb'].each { |f| require f }
+
+module Schoolmaster
+	class << self
+		def configure(silent = false)
+			yield(configuration)
+		end
+
+		def configuration
+			@configuration ||= Configuration.new
+		end
+	end
+end

data/schoolmaster.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'schoolmaster/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "schoolmaster"
+  spec.version       = Schoolmaster::VERSION
+  spec.authors       = ["Alex Handley"]
+  spec.email         = ["alex@seriousfox.co.uk"]
+  spec.summary       = "A gem that runs your tests, static code" \
+											 "analysis, security and best practice checks."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = ["schoolmaster"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+
+  spec.add_dependency "git", "~> 1.2.6"
+  spec.add_dependency "cane", "~> 2.6.0"
+  spec.add_dependency "brakeman", "~> 3.0.1"
+  spec.add_dependency "rails_best_practices", "~> 1.15.0"
+end

data/spec/analysers/base_analyser_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe Schoolmaster::BaseAnalyser do
+	context "when inheriting the BaseAnalyser" do
+		it "should execute the configured command" do
+			params = {
+				command: "madeup spec"
+			}
+
+			@klass = Class.new(Schoolmaster::BaseAnalyser)
+
+			analyser = @klass.new(params)
+			expect(analyser).to receive(:system).with("#{params[:command]} ")
+			analyser.run
+		end
+
+		it "should allow args to be injected into command str" do
+			params = {
+				command: "madeup spec"
+			}
+
+			@klass = Class.new Schoolmaster::BaseAnalyser do
+				def default_args
+					["beam_me_up"]
+				end
+			end
+
+			analyser = @klass.new(params)
+			expect(analyser).to receive(:system).with("#{params[:command]} beam_me_up")
+			analyser.run
+		end
+	end
+end
+

data/spec/analysers/best_practices_analyser_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe Schoolmaster::BestPracticesAnalyser do
+	context "the command param" do
+		it "should have the default system command" do
+			analyser = Schoolmaster::BestPracticesAnalyser.new
+			expected_command = "rails_best_practices . "
+			expect(analyser).to receive(:system).with expected_command
+			analyser.run
+		end
+
+		it "should be able to be overridden" do
+			analyser = Schoolmaster::BestPracticesAnalyser.new(command: "rails_best_practices app")
+			expected_command = "rails_best_practices app "
+			expect(analyser).to receive(:system).with expected_command
+			analyser.run
+		end
+	end
+end
+

data/spec/analysers/brakeman_analyser_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe Schoolmaster::BrakemanAnalyser do
+	context "the command param" do
+		it "should have the default system command" do
+			analyser = Schoolmaster::BrakemanAnalyser.new
+			expected_command = "brakeman . -q"
+			expect(analyser).to receive(:system).with expected_command
+			analyser.run
+		end
+
+		it "should be able to be overridden" do
+			analyser = Schoolmaster::BrakemanAnalyser.new(command: "brakeman app")
+			expected_command = "brakeman app -q"
+			expect(analyser).to receive(:system).with expected_command
+			analyser.run
+		end
+	end
+
+	context "the debug param" do
+		it "should allow debug to be turned on" do
+			allow(Schoolmaster.configuration).to receive(:debug).and_return(10)
+			analyser = Schoolmaster::BrakemanAnalyser.new
+			expected_command = "brakeman . "
+			expect(analyser).to receive(:system).with expected_command
+			analyser.run
+		end
+	end
+end
+

data/spec/analysers/cane_analyser_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe Schoolmaster::CaneAnalyser do
+	context "the command param" do
+		it "should have the default cane system command" do
+			analyser = Schoolmaster::CaneAnalyser.new
+			expected_command = "cane . --style-measure 100  --no-doc"
+			expect(analyser).to receive(:system).with expected_command
+			analyser.run
+		end
+
+		it "should be able to be overridden" do
+			analyser = Schoolmaster::CaneAnalyser.new(command: "cane app")
+			expected_command = "cane app --style-measure 100  --no-doc"
+			expect(analyser).to receive(:system).with expected_command
+			analyser.run
+		end
+	end
+
+	context "the characters_per_line param" do
+		it "should allow characters_per_line to be changed" do
+			allow(Schoolmaster.configuration).to receive(:characters_per_line)
+																					 .and_return(10)
+			analyser = Schoolmaster::CaneAnalyser.new
+
+			expected_command = "cane . --style-measure 10  --no-doc"
+			expect(analyser).to receive(:system).with expected_command
+			analyser.run
+		end
+	end
+
+	context "the require_file_comments param" do
+		it "should allow require_file_comments to be changed" do
+			allow(Schoolmaster.configuration).to receive(:require_file_comments)
+																					 .and_return(true)
+
+			analyser = Schoolmaster::CaneAnalyser.new
+			expected_command = "cane . --style-measure 100"
+			expect(analyser).to receive(:system).with expected_command
+			analyser.run
+		end
+	end
+end
+

data/spec/analysers/test_analyser_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe Schoolmaster::TestAnalyser do
+	context "the command param" do
+		it "should have the default system command" do
+			analyser = Schoolmaster::TestAnalyser.new
+			expected_command = "bundle exec rspec spec "
+			expect(analyser).to receive(:system).with expected_command
+			analyser.run
+		end
+
+		it "should be able to be overridden" do
+			analyser = Schoolmaster::TestAnalyser.new(command: "rake test")
+			expected_command = "rake test "
+			expect(analyser).to receive(:system).with expected_command
+			analyser.run
+		end
+	end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+require "bundler/setup"
+
+require_relative "../lib/schoolmaster"
+
+RSpec.configure do |config|
+  config.color = true
+	config.order = "random"
+end
+

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: schoolmaster
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Handley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: rails_best_practices
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+description: 
+email:
+- alex@seriousfox.co.uk
+executables:
+- schoolmaster
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/schoolmaster
+- lib/schoolmaster.rb
+- lib/schoolmaster/analysers/base_analyser.rb
+- lib/schoolmaster/analysers/best_practices_analyser.rb
+- lib/schoolmaster/analysers/brakeman_analyser.rb
+- lib/schoolmaster/analysers/cane_analyser.rb
+- lib/schoolmaster/analysers/test_analyser.rb
+- lib/schoolmaster/configuration.rb
+- lib/schoolmaster/suite_runner.rb
+- lib/schoolmaster/version.rb
+- schoolmaster.gemspec
+- spec/analysers/base_analyser_spec.rb
+- spec/analysers/best_practices_analyser_spec.rb
+- spec/analysers/brakeman_analyser_spec.rb
+- spec/analysers/cane_analyser_spec.rb
+- spec/analysers/test_analyser_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A gem that runs your tests, static codeanalysis, security and best practice
+  checks.
+test_files:
+- spec/analysers/base_analyser_spec.rb
+- spec/analysers/best_practices_analyser_spec.rb
+- spec/analysers/brakeman_analyser_spec.rb
+- spec/analysers/cane_analyser_spec.rb
+- spec/analysers/test_analyser_spec.rb
+- spec/spec_helper.rb