snipgem 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 900f13cdab2b7bc759bf4d189b8b3ff6548becfa
+  data.tar.gz: c8e4ce5352867021b0f7f2a57dcdbc9fbf640bde
+SHA512:
+  metadata.gz: 2d73b6b38d8dc5fab8d306b5e0097b8201f73e31dde617c497d5c211d089dd860c79aea118365741682c5234e392d35d1a966c344de2d7d0d4cf79ec4feb77c9
+  data.tar.gz: 4cd33c7bd54192de3050760eb422fb4fe53d0bed91bd9ecbc8159ff82c596c5e3e4ef9b770fd964110947ebcb62d8ef6f9254bfdb89e4a7f8f379398ca5f6575

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 jgerminario
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,42 @@
+require "bundler/gem_tasks"
+require 'fileutils'
+
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "seed test files"
+task :seed do
+	test_str1 = "# <snip>\nclass OrangeTree\n  attr_reader :age, :height\n  def initialize\n    @age = 0\n    @oranges = []\n  end\n#</snip>\n\n# test <snip> TITLE\n  def age!\n    @oranges += Array.new(rand(1..10)) { Orange.new } if @age > 5\n  end\n#</snip>\n\n#   ewre w<snip> test\n  def any_oranges?\n    !@oranges.empty?\n  end\n# test </snip> test\n\n  def pick_an_orange!\n"
+	test_str2 = "#<$> Title ggg\ndef method\n  \"code\"\nend\n#</$>\n\n#<$> Title 2323\ndef method\n  \"code\"\nend\n#</$>\n\n#<$> Title 4\ndef method\n  \"code\"\nend\n#</$>"
+	test_str3 = "# <snip> Title of first snip\n  desc \"create the database\"\n  task :create do\n    puts \"Creating file \#{DB_PATH} if it doesn't exist...\"\n    touch DB_PATH\n  end\n# </snip>\n\n# <snip> Title of this snip\n  desc \"drop the database\"\n  task :drop do\n    puts \"Deleting \#{DB_PATH}...\"\n    rm_f DB_PATH\n  end\n# </snip>\n\n# <snip> Title of first snip\n  desc \"create the database\"\n  task :create do\n    puts \"Creating file \#{DB_PATH} if it doesn't exist...\"\n    touch DB_PATH\n  end\n# </snip>\n\n# <snip> Title of this snip\n  desc \"drop the database\"\n  task :drop do\n    puts \"Deleting \#{DB_PATH}...\"\n    rm_f DB_PATH\n  end\n# </snip>"
+	test_str_js = "//<$> Title ggg\nvar test1 = 44;\nvar test2 = 22;\n//</$>\n\n//<$>\nvar test4 = \"Hola\";\n//</$>\n\n"
+
+	FileUtils.rm_rf('rspec/test_snip_files')
+	Dir.mkdir("rspec/test_snip_files")
+	Dir.mkdir("rspec/test_snip_files/subfolder")
+
+	File.open("my_snips.rb", "w+") do |file|
+		file << ""
+	end
+
+	File.open("rspec/test_snip_files/test.rb", "w+") do |file|
+     file << test_str1
+  end
+  File.open("rspec/test_snip_files/test2.rb", "w+") do |file|
+     file << test_str2
+  end
+  File.open("rspec/test_snip_files/subfolder/test3.rb", "w+") do |file|
+     file << test_str3
+  end
+  File.open("rspec/test_snip_files/subfolder/test_js.js", "w+") do |file|
+     file << test_str_js
+  end
+end
+
+desc "Run the specs"
+task :specs do
+	RSpec::Core::RakeTask.new(:spec)
+end
+
+task :default  => :specs

data/app/controllers/controller.rb

@@ -0,0 +1,20 @@
+require_relative '../models/utils/sourcefilereader'
+require_relative '../models/utils/codescanner'
+require_relative '../models/utils/destinationfilewriter'
+
+module CommandLineController
+
+  extend self
+
+  def run(file)
+    file_read = SourceFileReaderWriter.new(file)
+    to_run = file_read.convert_to_array_of_lines
+    CodeScanner.run(to_run, SourceFileReaderWriter.file_to_open)
+    DestinationFileWriter.run(Snippet.snippet_array)
+    DestinationFileWriter.run(Snippet.rb_snippets, "rb") if Snippet.rb_snippets.any?
+    DestinationFileWriter.run(Snippet.js_snippets, "js") if Snippet.js_snippets.any?
+    file_read.overwrite_existing_snips
+
+    Snippet.snippet_array = []
+  end
+end

data/app/models/snippet.rb

@@ -0,0 +1,37 @@
+class Snippet
+attr_accessor :snippet_array
+
+  @@snippet_array = []
+  @@snippet_counter = 0
+  attr_reader :code, :title, :line, :filename
+
+  def self.snippet_array
+    @@snippet_array
+  end
+
+  def self.snippet_counter
+    @@snippet_counter
+  end
+
+  def self.snippet_array=(arg)
+    @@snippet_array = arg
+  end
+
+  def self.rb_snippets
+    @@snippet_array.select {|snippet| snippet.filename.end_with?(".rb")}
+  end
+
+  def self.js_snippets
+    @@snippet_array.select {|snippet| snippet.filename.end_with?(".js")}
+  end
+
+  def initialize(args = {})
+    @code = args[:code]
+    @title = args[:title]
+    @@snippet_array << self
+    @@snippet_counter += 1
+    @line = args[:line]
+    @filename = args[:filename]
+  end
+
+end

data/app/models/utils/batchprocessing.rb

@@ -0,0 +1,11 @@
+class BatchProcessing
+
+  def self.process(directory)
+  	directory = directory.chomp('/')
+    Dir.glob(directory + "/**/*.{rb,js}") do |file|
+      next if file == '.' or file == '..'
+      CommandLineController.run(file)
+    end
+  end
+
+end

data/app/models/utils/codescanner.rb

@@ -0,0 +1,58 @@
+# Input ex ("\n" and whitespace are necessary to keep to preserve formatting):
+#["#<snip>\n", "  def age!\n", "    @oranges += Array.new(rand(1..10)) { Orange.new } if @age > 5\n", "  end\n", "#</snip>\n", "\n", "#<snip>\n", "  def any_oranges?\n", "    !@oranges.empty?\n", "  end\n", "#</snip>\n", "\n"]
+
+require_relative "../snippet"
+
+class CodeScanner
+  @scan_array = []
+  class << self; attr_reader :scan_array end
+  def self.run(scan_array, filename)
+    @scan_array = scan_array
+    while @scan_array.join.include?('<snip>') || @scan_array.join.include?('<$>')
+      Snippet.new(code: array_range, title: @title, line: @line, filename: filename)
+    end
+  end
+
+  def self.find_begin_range
+    @scan_array.each_with_index do |line, index|
+      if line.include?('<snip>') || line.include?('<$>')
+        find_title(index)
+        @line = index+1
+        strip_snip_tag(index)
+        return @begin_scan = index
+      end
+    end
+    return false
+  end
+
+  def self.find_end_range
+    @scan_array.each_with_index do |line, index|
+      if line.include?('</snip>') || line.include?('</$>')
+        strip_snip_tag(index)
+        return @end_scan = index
+      end
+    end
+    return false
+  end
+
+  def self.array_range
+    find_begin_range
+    find_end_range
+    @scan_array[@begin_scan+1..@end_scan-1].join
+  end
+
+  def self.strip_snip_tag(index)
+    @scan_array[index].sub!(/<snip>/,'<*snip*>')
+    @scan_array[index].sub!(/<\/snip>/,'</*snip*>')
+    @scan_array[index].sub!(/<\$>/,'<*$*>')
+    @scan_array[index].sub!(/<\/\$>/,'</*$*>')
+  end
+
+  def self.find_title(index)
+    matches = @scan_array[index].match(/(<snip>|<\$>)(.+)/)
+    if matches
+      @title = matches[2].strip
+    end
+    @title
+  end
+end

data/app/models/utils/destinationfilewriter.rb

@@ -0,0 +1,100 @@
+# Input ex:
+#[#<Snippet:0x007fc98c9cbd20 @code_array=["  def age!\n", "    @oranges += Array.new(rand(1..10)) { Orange.new } if @age > 5\n", "  end\n"]>, #<Snippet:0x007fc98c9ca678 @code_array=["  def any_oranges?\n", "    !@oranges.empty?\n", "  end\n"]>]
+
+
+require_relative '../../views/viewformatter'
+CONFIG_PATH = File.expand_path("../../../../config/filepath.config", __FILE__)
+LOG_PATH = File.expand_path("../../../../log/snip.log", __FILE__)
+
+module DestinationFileWriter
+
+  extend self
+
+  def check_config_file_for_snip_file
+    if snip_filepath
+      check_if_file_still_exists
+    else
+      abort(ViewFormatter.specify_path)
+    end
+  end 
+
+  def snip_filepath
+    File.readlines(CONFIG_PATH)[0]
+  end
+
+  def check_if_file_still_exists
+    if File.exist?(snip_filepath)
+      @snip_file_name = snip_filepath
+    else
+      abort(ViewFormatter.output_file_not_found(snip_file))
+    end
+  end
+
+  def run(snippet_array, type=nil)
+    directory = File.dirname(@snip_file_name)
+    case type
+    when "rb"
+      filename = directory + "/my_snips.rb"
+      File.new(filename, 'w') unless File.exist?(filename)
+    when "js"
+      filename = directory + "/my_snips.js"
+      File.new(filename, 'w') unless File.exist?(filename)
+    else
+      filename = @snip_file_name
+    end
+    write_file(snippet_array, filename, type)
+  end  
+
+
+  def save_file_path_to_config_file(filedir)
+    snip_file = File.absolute_path(filedir).chomp('/') + "/my_snips.txt"
+    File.open(CONFIG_PATH, "w+") do |f|
+      f << snip_file
+    end
+    unless File.exist?(snip_file)
+      File.new(snip_file, 'w')
+      abort(ViewFormatter.new_file(snip_file))
+    end
+  end
+
+  def determine_next_index(filename)
+    last_snip_scan = File.readlines(filename).reverse.join
+    if last_snip_scan.match(/\*\*\*\* Snippet (\d+):/)
+      last_snip_scan.match(/\*\*\*\* Snippet (\d+):/).captures[0].to_i+1
+    else
+      1
+    end
+  end
+
+  def write_file(snippet_array, filename, type)
+    File.open(filename, "a") do |file|
+      snippet_array.each_with_index do |snip_object, index|
+        file << ViewFormatter.snippet_indexer(determine_next_index(filename)+index, snip_object.title, type)
+        file << ViewFormatter.status_line(snip_object.line, type)
+        file << "\n"
+        file << snip_object.code
+        file << "\n\n"
+        unless type 
+          log = ViewFormatter.snip_terminal_status(snip_object.filename, snip_object.line)
+          puts log
+          write_to_log_file(log)
+        end
+      end
+    end
+  end
+
+  def write_to_log_file(log)
+    File.open(LOG_PATH, "a") do |file|
+      file << Time.now.strftime("%m-%d-%Y").to_s + " " + log + "\n"
+    end
+  end
+
+  def full_file_directory
+    File.absolute_path(@snip_file_name)
+  end
+
+  def log_filepath
+    LOG_PATH
+  end
+
+end

data/app/models/utils/sourcefilereader.rb

@@ -0,0 +1,63 @@
+# Input ex.
+# #<snip>
+#   def age!
+#     @oranges += Array.new(rand(1..10)) { Orange.new } if @age > 5
+#   end
+# #</snip>
+
+# #<snip>
+#   def any_oranges?
+#     !@oranges.empty?
+#   end
+# #</snip>
+
+class SourceFileReaderWriter
+attr_reader :file_to_open
+
+  def self.file_to_open
+    @@file_to_open
+  end
+
+  def initialize(file_to_open)
+    @@file_to_open = file_to_open
+    @array_of_lines = []
+    @overwrite = []
+  end
+
+  def convert_to_array_of_lines
+    File.open(@@file_to_open, "r").each do |line|
+      @array_of_lines << line
+    end
+    @array_of_lines
+  end
+
+  def overwrite_existing_snips
+    File.open(@@file_to_open, "r+").each do |line|
+      @overwrite << line
+      end
+      overwrite
+      rewrite_whole_file
+    end
+
+  def overwrite
+    @overwrite.each_with_index do |element, index|
+      if element.include?('<snip>') || element.include?('<$>')
+        @overwrite[index].sub!(/<snip>/,'<*snip*>')
+        @overwrite[index].sub!(/<\$>/,'<*$*>')
+      end
+      if element.include?('</snip>') || element.include?('</$>')
+        @overwrite[index].sub!(/<\/snip>/,'</*snip*>')
+        @overwrite[index].sub!(/<\/\$>/,'</*$*>')
+      end
+    end
+  end
+
+  def rewrite_whole_file
+    File.open(@@file_to_open, "w") do |file|
+      @overwrite.each do |line|
+        file << line
+      end
+    end
+  end
+
+end

data/app/views/viewformatter.rb

@@ -0,0 +1,133 @@
+# View component for file writing operations and possibly terminal output
+require 'date'
+
+module ViewFormatter
+
+	extend self
+
+	def snippet_indexer(index, title, type)
+		if type == "js"
+		  "// **** Snippet " + (index).to_s + ": #{title} **** \n"
+		else
+			"# **** Snippet " + (index).to_s + ": #{title} **** \n"
+		end
+	end
+
+	def file_not_found
+		"File not found, please try again."
+	end
+
+	def invalid_file
+		"File must be a .js or .rb file."
+	end
+
+	def success_message(filedir)
+		if Snippet.snippet_counter > 0
+			"Your snippet file has been successfully updated with #{Snippet.snippet_counter} new snips at: '#{filedir}'"
+		else
+			"No snips found in the specified files or directories."
+		end
+	end
+
+  def status_line(line, type)
+  	if type == "js"
+   	  "// Snipped from #{SourceFileReaderWriter.file_to_open}:#{line} on #{Time.now.strftime("%m-%d-%Y")}"
+   	else
+   		"# Snipped from #{SourceFileReaderWriter.file_to_open}:#{line} on #{Time.now.strftime("%m-%d-%Y")}"
+   	end
+  end
+
+  def snip_terminal_status(filename, line)
+  	"#{File.absolute_path(filename)}:#{line} snipped"
+  end
+
+  def specify_path
+  	"Please specify where you would like to save your snippets by running 'snip -f <filepath>'"
+  end
+
+  def output_file_not_found(file)
+  	"Output file '#{file}' not found, please specify existing file location or desired location for new file by running 'snip -f <filepath>'"
+  end
+
+  def new_file(filename)
+  	"New snippet file created at #{File.absolute_path(filename)}"
+  end
+
+  def terminal_help_message
+  	"
+
+*** First time setup: ***
+
+  snip -f <directory>
+
+This specifies the directory where you would like to save your snippets. 'my_snips.txt' will be automatically created if it doesn't already exist. If you move your my_snips.txt file, you will need to run 'snip -f' again.
+
+Ruby and JavaScript snippet files will be automatically created in the same directory as the .txt file.
+
+
+*** To add snip tags into your code: ***
+
+Ruby:
+
+  # <snip> Title goes here
+  5.times do {|x| puts x}
+  # </snip>
+
+JS:
+
+  // <snip> Title goes here
+  var test = 1234;
+  // </snip>
+
+You can alternately use <$> and </$>. Your tags will be replaced with <*snip*> and/or <*$*> after running 'snip'.
+
+
+*** Ongoing usage: ***
+
+  snip <filename> - process a single file
+  snip <directory> - process a directory recursively
+  snip -l - view log history if you need to debug previous snips
+  snip -d - display your snips in terminal
+
+Visit https://github.com/jgerminario/snip for more information or to submit bug reports/feature requests.
+
+"
+	end
+
+	def new_file_path
+		"Snippet file location saved as #{File.absolute_path(ARGV[1])}/my_snips.txt"
+	end
+
+	def no_args_message
+		"Welcome to snip. Type 'snip --help' for help"
+	end
+
+	def specify_filename
+		"Please specify a filename after '-f'"
+	end
+
+	def need_to_specify_directory
+		"Please specify an existing directory to save your snippets to"
+	end
+
+	def show_log(log_file)
+		if File.readlines(log_file)[0]
+			File.readlines(log_file)
+		else
+			"Log file is empty"
+		end
+	end
+
+	def show_snips(file)
+		if file
+			if File.readlines(file)[0]
+				File.readlines(file)
+			else
+				"Snippet file is empty"
+			end
+		else
+			"Snippet file doesn't exist. Specify where you would like to save your snippets by running 'snip -f <filepath>"	
+		end
+	end
+
+end

data/bin/snip

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'snip'
+
+runner = Snip::Run.new
+runner.execute

data/lib/snip/version.rb

@@ -0,0 +1,3 @@
+module Snip
+  VERSION = "0.0.5"
+end

data/lib/snip.rb

@@ -0,0 +1,56 @@
+require "snip/version"
+require_relative '../app/controllers/controller'
+require_relative '../app/models/utils/batchprocessing'
+
+module Snip
+	class Run
+		def execute
+			unless ARGV[0]
+				abort(ViewFormatter.no_args_message)
+			end
+
+			if ARGV[0] == "--help"
+				abort(ViewFormatter.terminal_help_message)
+			end
+
+			if ARGV[0] == "-f"
+				if !ARGV[1].nil?
+					if File.directory?(ARGV[1])
+						DestinationFileWriter.save_file_path_to_config_file(ARGV[1])
+						abort(ViewFormatter.new_file_path)
+					else
+						abort(ViewFormatter.need_to_specify_directory)
+					end
+				else
+					abort(ViewFormatter.specify_filename)
+				end
+			end
+
+			if ARGV[0] == "-l"
+				puts ViewFormatter.show_log(DestinationFileWriter.log_filepath)
+				abort
+			end
+
+			if ARGV[0] == "-d"
+				puts ViewFormatter.show_snips(DestinationFileWriter.snip_filepath)
+				abort
+			end
+
+			DestinationFileWriter.check_config_file_for_snip_file
+
+			if File.directory?(ARGV[0])
+				BatchProcessing.process(ARGV[0])
+			elsif File.file?(ARGV[0])
+				if ARGV[0].end_with?(".rb") || ARGV[0].end_with?(".js")
+				  CommandLineController.run(ARGV[0])
+				else
+					abort(ViewFormatter.invalid_file)
+				end
+			else
+				abort(ViewFormatter.file_not_found)
+			end
+
+			puts ViewFormatter.success_message(DestinationFileWriter.full_file_directory)
+		end
+	end
+end