byebug-cleaner 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f32bd5a9f7563a4ec1fec0d284fe73151a30bc59
+  data.tar.gz: 06d3edacd09788b94ac1641cf1b5efcfcd4fd3f4
+SHA512:
+  metadata.gz: b44de141b58d4019a4160aa567509923a004f78f5d9d981b498c5008d81a612d34dd79247c4fbc8c3c4a56c55b9f4e57a79d595ad093daa862162f757f27c290
+  data.tar.gz: 7824a8b2c221b331c644d1003e97b281869e539f16df9f85b4947efe337893f2e4f4d87a46d1053796709b943b85b17339c60eb57368b3f1beee80a83b525d1f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Ilyas Valiullov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# ByebugCleaner
+
+
+## Usage
+You can remove all byebug tag from source code using rake task:
+```bash
+rails byebug:clean
+```
+Default path for clean is [app/*].  Script recursively search byebug tag in files and delete whole line.
+
+Task default create backup files.
+Get help for more options:
+```bash
+rails byebug:clean -- -h
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'byebug-cleaner', github: "IlyasValiullov/byebug-cleaner"
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ByebugCleaner'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+load 'tasks/clean_tasks.rake'
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/byebug-cleaner.rb

@@ -0,0 +1,4 @@
+require 'optparse'
+require 'fileutils'
+	
+require 'byebug/byebug'

data/lib/byebug/byebug.rb

@@ -0,0 +1,6 @@
+
+require 'byebug/cleaner/railtie' if defined?(Rails)
+require 'byebug/cleaner/version'
+require 'byebug/cleaner/output'
+require 'byebug/cleaner/parser'
+require 'byebug/cleaner/cleaner'

data/lib/byebug/cleaner/cleaner.rb

@@ -0,0 +1,51 @@
+require 'byebug/cleaner/output'
+
+module ByebugCleaner
+	class Cleaner
+		include ByebugCleaner
+
+		def self.clean argv
+			
+			#Get options for clean
+	  	optparse = ArgumentParser.new
+	  	options = optparse.parse(argv[-1..argv.size])
+
+
+	  	root = Pathname.new("#{Dir.pwd}")
+	  	pwd = "#{Dir.pwd}/#{options.dir}"
+	  	puts "Folder for searching is #{options.dir}"
+
+
+	  	dirs = Dir[ File.join(pwd, '**', '*') ]
+	  	dirs.delete_if {|f| File.directory?(f) }
+
+	  	filelist = Rake::FileList.new
+	  	filelist.include(dirs)
+
+	  	results = []
+	  	filelist.each do |file_name|
+	  		str = IO.read(file_name)    
+				next if !str.match(/.*byebug.*/)
+				FileUtils.cp(file_name, "#{file_name}.backup") if options.backup
+				file_path = Pathname.new(file_name)
+				file_clean_path = file_path.relative_path_from(root) 
+
+				text = File.read(file_name)
+	  		new_content = text.gsub(/.*byebug.*/, "")
+
+	  		File.open(file_name, "w") {|file| file.puts new_content } 
+
+	  		results << file_clean_path
+	   	end
+
+	   	if results.size > 0
+	   		puts "Files was changed:"
+	   		results.each do |file_name| 
+	   			puts ByebugCleaner::green_str(" - #{file_name}")
+	   		end
+	   	else
+	   		puts ByebugCleaner::cyan_str("Byebug wasn't found.")
+	   	end
+	  end
+	end
+end

data/lib/byebug/cleaner/output.rb

@@ -0,0 +1,8 @@
+module ByebugCleaner
+	def self.green_str string
+  	"\e[32m#{string}\e[0m"
+  end
+ 	def self.cyan_str string
+  	"\e[36m#{string}\e[0m"
+  end
+end

data/lib/byebug/cleaner/parser.rb

@@ -0,0 +1,81 @@
+module ByebugCleaner
+  class ArgumentParser
+
+    class Options
+      attr_accessor :dir, :backup, :test
+
+      def initialize
+        self.dir = "app"
+        self.backup = true
+        self.test = 0
+      end
+
+      def define_options(parser)
+        parser.banner = "Usage: rake byebug:clean -- [options]"
+        parser.separator "Task recursively search files where 'byebug' uses and remove this line from file."
+        parser.separator ""
+        parser.separator "Default options:"
+        parser.separator "	Dir - {RAILS_APP}/app"
+        parser.separator "	Backup - true"
+        parser.separator ""
+        parser.separator "Specific options:"
+
+        # add additional options
+        dir_option(parser)
+        boolean_backup_option(parser)
+
+        parser.separator ""
+        parser.separator "Common options:"
+        # No argument, shows at tail.  This will print an options summary.
+        # Try it and see!
+  			parser.on("-h", "--help", "Prints this help") do
+  				puts parser
+  				exit
+  			end
+        # Another typical switch to print the version.
+        parser.on("-v", "Show version") do
+          puts VERSION
+          exit
+        end
+        parser.separator ""
+        parser.separator "Examples:"
+        parser.separator "	rake byebug:clean"
+        parser.separator "	rake byebug:clean -- -dspec"
+        parser.separator "	rake byebug:clean -- --dir=app/models --no-debug"
+      end
+
+
+      def dir_option(parser)
+        # Cast 'time' argument to a Time object.
+        parser.on("-dDIR", "--dir=DIR", String, "Set dir for searching") do |dir|
+          self.dir = dir
+        end
+      end
+
+
+      def boolean_backup_option(parser)
+        # Boolean switch.
+        parser.on("-b", "--[no-]backup", "Backup files") do |b|
+          self.backup = b
+        end
+      end
+    end
+
+    #
+    # Return a structure describing the options.
+    #
+    def parse(args)
+      # The options specified on the command line will be collected in
+      # *options*.
+      @options = Options.new
+      opt_parser = OptionParser.new  do |parser|
+      	@options.define_options(parser)
+      end
+      opt_parser.parse!(args)
+      
+      @options
+    end
+
+    # attr_reader :parser, :options
+  end  # class OptparseExample
+end

data/lib/byebug/cleaner/railtie.rb

@@ -0,0 +1,5 @@
+class Railtie < Rails::Railtie
+ 	rake_tasks do
+    load 'tasks/clean_tasks.rake'
+  end
+end

data/lib/byebug/cleaner/version.rb

@@ -0,0 +1,3 @@
+module ByebugCleaner
+  VERSION = '0.1.2'
+end

data/lib/tasks/clean_tasks.rake

@@ -0,0 +1,8 @@
+require 'byebug-cleaner.rb'
+
+namespace :byebug do
+  desc "Remove all byebug commands, 'byebug:clean -- -h' for more details."
+  task :clean do
+  	ByebugCleaner::Cleaner.clean(ARGV)
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: byebug-cleaner
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Ilyas Valiullov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Remove byebug tag before push your code in repos.
+email:
+- ilyas.valiullov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/byebug-cleaner.rb
+- lib/byebug/byebug.rb
+- lib/byebug/cleaner/cleaner.rb
+- lib/byebug/cleaner/output.rb
+- lib/byebug/cleaner/parser.rb
+- lib/byebug/cleaner/railtie.rb
+- lib/byebug/cleaner/version.rb
+- lib/tasks/clean_tasks.rake
+homepage: https://github.com/IlyasValiullov/byebug-cleaner
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Gem for clean byebug tag from source code.
+test_files: []