private_please 0.0.1 → 0.0.2

data/CHANGELOG

@@ -0,0 +1,5 @@
+v0.0.2
+	- only display the report if PrivatePlease.active?
+
+v0.0.1
+	- first functional version

data/TODO

@@ -0,0 +1,22 @@
+
+DSL
+	- global method marking :
+
+		ex:
+
+			private_please
+		    def foo ..
+		    def bar ..
+			public
+
+		is the same as :
+			...
+	    def foo ..
+	    def bar ..
+			private_please :foo, :bar
+
+Report :
+	- display list of methods that were never called
+
+Doc
+	- write README

data/lib/private_please.rb

@@ -10,7 +10,7 @@ module PrivatePlease
   def private_please(*args)
     klass = self
     args.reject!{|m| !klass.instance_methods.include?(m.to_s)}
-    candidates[klass.to_s] += args
+    storage.candidates[klass.to_s] += args
     args.each do |m|
       mark_method(m)
     end
@@ -40,16 +40,6 @@ module PrivatePlease
     Configuration .reset_before_new_test
   end
 
-
-#--------------
-# candidates
-#--------------
-
-
-  def candidates                ; storage.candidates                 end
-  def inside_called_candidates  ; storage.inside_called_candidates   end
-  def outside_called_candidates ; storage.outside_called_candidates  end
-
 #--------------
 # report
 #--------------
@@ -81,12 +71,13 @@ private
     end
   end
 
-
 end
 
 Module.send :include, PrivatePlease
 
 at_exit {
-  puts '-'*888
-  puts PrivatePlease.report.to_s
+  if PrivatePlease.active?
+    puts '-'*888
+    puts PrivatePlease.report.to_s
+  end
 }

data/lib/private_please/version.rb

@@ -1,3 +1,3 @@
 module PrivatePlease
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/private_please.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |gem|
   gem.version       = PrivatePlease::VERSION
 
   gem.add_development_dependency 'rake' # to run 'All specs' in Rubymine
-  gem.add_development_dependency 'todo_next'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'guard-rspec'
 end

data/spec/01_marking_methods_spec.rb

@@ -2,6 +2,8 @@ require 'spec_helper'
 
 describe PrivatePlease, 'marking methods' do
 
+  let(:storage) { PrivatePlease.storage }
+
   it('records the candidates and associate them to the owning class') do
     module Marking
       class Simple1
@@ -11,7 +13,7 @@ describe PrivatePlease, 'marking methods' do
         private_please  :bar, :buz
       end
     end
-    PrivatePlease.candidates['Marking::Simple1'].should == [:bar, :buz]
+    storage.candidates['Marking::Simple1'].should == [:bar, :buz]
   end
 
   it('does not record invalid candidates (method not found in the class)') do
@@ -22,7 +24,7 @@ describe PrivatePlease, 'marking methods' do
         private_please  :invalid_method
       end
     end
-    PrivatePlease.candidates['Marking::Simple2'].should == [:foo]
+    storage.candidates['Marking::Simple2'].should == [:foo]
   end
 
 end

data/spec/02_calling_methods_spec.rb

@@ -4,6 +4,7 @@ describe PrivatePlease, 'calling marked methods' do
   before() do
     PrivatePlease.activate(true)
   end
+  let(:storage) { PrivatePlease.storage }
 
   module Calling
     class Simple
@@ -20,14 +21,14 @@ describe PrivatePlease, 'calling marked methods' do
     before { Calling::Simple.new.public_m }
 
     it('records the call to the p+p method in PrivatePlease.inside_called_candidates') do
-      PrivatePlease.inside_called_candidates[ 'Calling::Simple'].to_a.should == [:private_m]
-      PrivatePlease.outside_called_candidates['Calling::Simple'].to_a.should == []
+      storage.inside_called_candidates[ 'Calling::Simple'].to_a.should == [:private_m]
+      storage.outside_called_candidates['Calling::Simple'].to_a.should == []
     end
 
     it('records multiple calls only once') do
       2.times{ Calling::Simple.new.public_m }
-      PrivatePlease.inside_called_candidates[ 'Calling::Simple'].to_a.should == [:private_m]
-      PrivatePlease.outside_called_candidates['Calling::Simple'].to_a.should == []
+      storage.inside_called_candidates[ 'Calling::Simple'].to_a.should == [:private_m]
+      storage.outside_called_candidates['Calling::Simple'].to_a.should == []
     end
   end
 
@@ -43,14 +44,14 @@ describe PrivatePlease, 'calling marked methods' do
     end
 
     it('records the call to the p+p method in PrivatePlease.inside_called_candidates') do
-      PrivatePlease.inside_called_candidates[ 'Calling::Simple'].to_a.should == []
-      PrivatePlease.outside_called_candidates['Calling::Simple'].to_a.should == [:private_m]
+      storage.inside_called_candidates[ 'Calling::Simple'].to_a.should == []
+      storage.outside_called_candidates['Calling::Simple'].to_a.should == [:private_m]
     end
 
     it('records multiple calls only once') do
       2.times{ Calling::Simple.new.private_m }
-      PrivatePlease.inside_called_candidates[ 'Calling::Simple'].to_a.should == []
-      PrivatePlease.outside_called_candidates['Calling::Simple'].to_a.should == [:private_m]
+      storage.inside_called_candidates[ 'Calling::Simple'].to_a.should == []
+      storage.outside_called_candidates['Calling::Simple'].to_a.should == [:private_m]
     end
   end
 

data/spec/03_configuration_spec.rb

@@ -22,6 +22,7 @@ describe PrivatePlease, 'configuring PrivatePlease' do
     PrivatePlease::Configuration.reset_before_new_test
     PrivatePlease.should_not be_active
   end
+  let(:storage) { PrivatePlease.storage }
 
   context 'when disabled' do
 
@@ -31,8 +32,8 @@ describe PrivatePlease, 'configuring PrivatePlease' do
     it('is not active') { PrivatePlease.should_not be_active }
 
     it 'does NOT record the calls to candidates' do
-      PrivatePlease.inside_called_candidates[ 'Config::Simple'].to_a.should == []
-      PrivatePlease.outside_called_candidates['Config::Simple'].to_a.should == []
+      storage.inside_called_candidates[ 'Config::Simple'].to_a.should == []
+      storage.outside_called_candidates['Config::Simple'].to_a.should == []
     end
   end
 
@@ -44,8 +45,8 @@ describe PrivatePlease, 'configuring PrivatePlease' do
     it('is active') { PrivatePlease.should be_active }
 
     it 'DOES record the calls to candidates' do
-      PrivatePlease.inside_called_candidates[ 'Config::Simple'].to_a.should == [:private_m]
-      PrivatePlease.outside_called_candidates['Config::Simple'].to_a.should == [:private_m]
+      storage.inside_called_candidates[ 'Config::Simple'].to_a.should == [:private_m]
+      storage.outside_called_candidates['Config::Simple'].to_a.should == [:private_m]
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: private_please
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Alain Ravet
@@ -43,7 +43,7 @@ dependencies:
         version: "0"
   prerelease: false
   type: :development
-  name: todo_next
+  name: rspec
   requirement: *id002
 - !ruby/object:Gem::Dependency 
   version_requirements: &id003 !ruby/object:Gem::Requirement 
@@ -57,22 +57,8 @@ dependencies:
         version: "0"
   prerelease: false
   type: :development
-  name: rspec
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  type: :development
   name: guard-rspec
-  requirement: *id004
+  requirement: *id003
 description: Test if methods can be made private
 email: 
 - alainravet@gmail.com
@@ -85,11 +71,13 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rspec
+- CHANGELOG
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- TODO
 - lib/private_please.rb
 - lib/private_please/candidates.rb
 - lib/private_please/configuration.rb
@@ -104,7 +92,6 @@ files:
 - spec/03_configuration_spec.rb
 - spec/04_at_exit_report_printing_spec.rb
 - spec/spec_helper.rb
-- spec/todo_next_spec.rb
 homepage: https://github.com/alainravet/private_please
 licenses: []
 
@@ -144,4 +131,3 @@ test_files:
 - spec/03_configuration_spec.rb
 - spec/04_at_exit_report_printing_spec.rb
 - spec/spec_helper.rb
-- spec/todo_next_spec.rb

data/spec/todo_next_spec.rb

@@ -1,52 +0,0 @@
-require 'rubygems'
-require 'rspec'
-require 'todo_next'
-
-todo_next(<<TEXT)
-* marking 1 method
-  example :
-    def foo
-      ..
-    end
-    private_please :foo
-
-  * adds the method to $private_please_candidates
-
-Marking 2 methods in 1 call
-  example :
-    ..
-    private_please :foo, :bar
-
-  * adds the 2 method to $private_please_candidates
-
-Global usage
-  example :
-    ..
-    private_please
-      def foo .. end
-      def bar .. end
-
-  * adds the 2 method to $private_please_candidates
-
-An outside call to a candidate marked method
-  - goes through as is the method waspublic
-  - $private_please_called_candidates  << the candidate
-  - $private_please_INVALID_candidates << the candidate
-
-An inside call to a candidate marked method
-  - goes through
-  - $private_please_called_candidates << the candidate
-
-Configuration
-  - 'private_please' is inactive by default
-  'private_please' can be activate
-    - via ENV['private_please']=true
-    - PrivatePlease.activate(true)
-
-at_exit
-  - prints a report about the candidates in STDOUT
-
-TEXT
-
-# √ == passed   => same as a comment line
-# * == current  => leading char - '*' - is kept