event_reporter 1.0.0

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (C) 2013 Raphael Weiner
+
+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,37 @@
+# Event Reporter
+
+Allows for inspection, filtering, printing and saving of csv containing event attendees through CLI.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'event_reporter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install event_reporter
+
+## Usage
+
+For help:
+    $ help
+
+Example:
+    $ load
+    $ find first_name (chris, sarah) and state (co, ky)
+    $ add last_name smith
+    $ queue print by last_name
+    $ queue save to results.csv
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/bin/event_attendees.csv

@@ -0,0 +1 @@
+ ,RegDate,first_Name,last_Name,Email_Address,HomePhone,Street,City,State,Zipcode

data/bin/event_reporter

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$:.unshift("lib")
+
+require 'event_reporter/runner'
+
+EventReporter::Runner.new

data/bin/help.yml

@@ -0,0 +1,10 @@
+find           : find <attribute> <criteria>     searches csv for specific criteria
+load           : load <filename>                 erase any loaded data and parse the specified file. If no filename is given default to event_attendees.csv
+queue_count    : queue count                     outputs how many records are in the current queue
+queue_clear    : queue clear                     empty the queue
+queue_print    : queue print                     print out a tab-delimited data table with a header row
+queue_print_by : queue print by <attribute>      print the data table sorted by the specified attribute like zipcode
+queue_save_to  : queue save to <filename.csv>    exports current queue to specified filename as a CSV
+add            : add <attribute> <criteria>      exports current queue to specified filename as a CSV
+subtract       : subtract <attribute> <criteria> exports current queue to specified filename as a CSV
+quit           : quit                            exits program

data/event_reporter.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |gem|
+  gem.name          = "event_reporter"
+  gem.version       = "1.0.0"
+  gem.author        = "Raphael Weiner"
+  gem.email         = "raphael.weiner@gmail.com"
+  gem.summary       = "Loads csv of event attendees and allows for searching"
+  gem.description   = %q{
+    Allows for inspection, filtering, printing and saving of csv containing
+    list of event attendees through CLI.
+  }
+  gem.homepage      = "http://github.com/raphweiner/event_reporter"
+
+  gem.files         = Dir["{bin,lib}/**/*"] + %w(
+                        README.md
+                        LICENSE
+                        event_reporter.gemspec
+                      )
+  gem.executables   = [ 'event_reporter' ]
+  
+  gem.required_ruby_version  = '>=1.9'
+  gem.has_rdoc = false
+  # gem.add_dependency 'CSV'
+  # gem.add_dependency 'yaml'
+  gem.add_dependency 'json'
+  gem.add_dependency 'nokogiri'
+end

data/lib/event_reporter/accept_any_input.rb

@@ -0,0 +1,32 @@
+module EventReporter
+  module AcceptAnyInput
+    class << self
+      def read_char
+        begin
+          old_state = `stty -g`
+          system "stty raw -echo"
+          c = get_char
+        rescue => ex
+          puts "#{ex.class}: #{ex.message}"
+          puts ex.backtrace
+        ensure
+          system "stty #{old_state}"
+        end
+        return c
+      end
+
+      def get_char
+        c = STDIN.getc.chr
+        if(c=="\e")
+          extra_thread = Thread.new{
+            c = c + STDIN.getc.chr
+            c = c + STDIN.getc.chr
+          }
+          extra_thread.join(0.00001)
+          extra_thread.kill
+        end
+        c
+      end
+    end
+  end
+end

data/lib/event_reporter/attendee.rb

@@ -0,0 +1,11 @@
+module EventReporter
+  Attendee = Struct.new(:last_name,
+                        :first_name,
+                        :email, 
+                        :zipcode, 
+                        :city, 
+                        :state, 
+                        :address, 
+                        :phone_number
+                        )
+end

data/lib/event_reporter/cache.rb

@@ -0,0 +1,42 @@
+module EventReporter
+  class Cache
+    attr_accessor :queue
+    include ParseInput
+
+    def initialize
+      @queue = []
+    end
+
+    def route_queue(input)
+      command, leftovers = parse_input(input)
+      method = "queue_#{command}"
+      if respond_to? method
+        send(method, leftovers)
+      else
+        throw(:top, "Unknown queue command '#{command}'")
+      end
+    end
+
+    def queue_count(leftovers)
+      puts "There are #{@queue.length} records in your queue"
+    end
+
+    def queue_clear(leftovers)
+      @queue = []
+      puts "Queue is cleared"
+    end
+
+    def queue_print(leftovers)
+      if leftovers[0] == 'by'
+        Print.queue_print_by(leftovers[1], @queue)
+      else
+        Print.queue_print(@queue)
+      end
+    end
+
+    def queue_save(leftovers)
+      throw(:top, "Unknown save command") if leftovers[0] != 'to'
+      Save.route_save_to(leftovers[1], @queue)
+    end
+  end
+end

data/lib/event_reporter/cleaners.rb

@@ -0,0 +1,41 @@
+module EventReporter
+  module Cleaners
+    class << self
+      def clean_name(name)
+        name.to_s.chomp.downcase.capitalize
+      end
+
+      def clean_email(email)
+        email.to_s
+      end
+
+      def clean_zipcode(zipcode)
+        zipcode.to_s.rjust(5,"0")[0..4]
+      end
+
+      def clean_city(city)
+        city.to_s.downcase.chomp.capitalize
+      end
+
+      def clean_state(state)
+        state.to_s[0..1].upcase
+      end  
+
+      def clean_address(address)
+        address.to_s
+      end
+
+      def clean_phone_number(phone_number)
+        cleaned_number = phone_number.scan(/\d/).join("")
+        number_length = cleaned_number.length
+        if number_length == 10
+          cleaned_number
+        elsif number_length == 11 and phone_number[0] == '1'
+          phone_number[1..10]
+        else
+          '0'*10
+        end
+      end
+    end  
+  end
+end

data/lib/event_reporter/csv_parser.rb

@@ -0,0 +1,33 @@
+module EventReporter
+  class CSVParser
+    def initialize(filename)
+      csv_file = File.join(File.dirname(__FILE__), "../../bin/#{filename}")
+      throw(:top, "File not found :(") if !File.exists?(csv_file)
+      @contents = CSV.open(csv_file,
+                           :headers => true,
+                           :header_converters => :symbol)
+    end
+
+    def parse
+      @contents.map do |line|
+        last_name = Cleaners::clean_name(line[:last_name])
+        first_name = Cleaners::clean_name(line[:first_name])
+        email = Cleaners::clean_email(line[:email_address])
+        zipcode = Cleaners::clean_zipcode(line[:zipcode])
+        city = Cleaners::clean_city(line[:city])
+        state = Cleaners::clean_state(line[:state])
+        address = Cleaners::clean_address(line[:street])
+        phone_number = Cleaners::clean_phone_number(line[:homephone])
+        Attendee.new(last_name,
+                     first_name,
+                     email, 
+                     zipcode,
+                     city,
+                     state,
+                     address,
+                     phone_number
+                     )
+      end
+    end
+  end
+end

data/lib/event_reporter/database.rb

@@ -0,0 +1,116 @@
+module EventReporter
+  class Database
+    include ParseInput
+
+    def initialize
+      @attendees = []
+      @cache = Cache.new
+    end
+
+    def route_queue(input)
+      command, leftovers = parse_input(input)
+      if command == 'find'
+        route_find('queue', leftovers)
+      else
+        @cache.route_queue(input)
+      end
+    end
+
+    def load_csv(filename)
+      filename = filename.empty? ? "event_attendees.csv" : filename[0]
+      @attendees = CSVParser.new(filename).parse
+
+      puts "Loaded #{filename} (#{@attendees.length} attendees)"
+    end
+
+    def route_find(scope, instructions)
+      throw(:top, "Your database is empty (try 'load')") if @attendees.empty?
+      @cache.queue = if instructions.include?("and")
+        advanced_find(scope, instructions, "and")
+      elsif instructions.include?("or")
+        advanced_find(scope, instructions, "or")
+      else
+        initiate_search(scope, instructions)
+      end
+
+      @cache.queue_count("")
+      # remove parameter after Frank's feedback
+    end
+
+    def advanced_find(scope, instructions, logic)
+      instructions = instructions.join(" ").split(" #{logic} ")
+
+      search1 = instructions[0].split(" ")
+      search2 = instructions[1].split(" ")
+
+      result1 = initiate_search(scope, search1)
+      result2 = initiate_search(scope, search2)
+
+      if logic == "and"
+        return result1 & result2
+      elsif logic == "or"
+        return result1 | result2
+      end
+    end
+
+    def initiate_search(scope, input)
+      throw(:top, "Incorrect find input") if input.length < 2
+
+      attribute, criterias = parse_atts_crits(input)
+
+      results = criterias.map {|criteria| search(scope, attribute, criteria)}
+      results.reduce(&:|)
+    end
+
+    def parse_atts_crits(input)
+      attribute = input[0]
+      criterias = input[1..-1].join(" ").split(",")
+      
+      criterias.map! do |criteria| 
+        criteria.gsub("(", "").gsub(")", "").strip
+      end
+
+      validate_input(attribute, criterias)
+      return attribute, criterias
+    end
+
+    def validate_input(attribute, criterias)
+      if not HEADERS.include? attribute
+        throw(:top, "Attribute '#{attribute}' not found")
+      elsif criterias.nil? || criterias.empty?
+        throw(:top, "Please enter a find criteria")
+      end
+    end
+
+    def search(scope, attribute, criteria)
+      db = scope == 'all' ? @attendees : @cache.queue
+      db.select do |attendee|
+        criteria.chomp.downcase == attendee[attribute].downcase
+      end
+    end
+
+    def subtract(instructions)
+      attribute, criteria = parse_maths_input(instructions)
+      @cache.queue.delete_if do |attendee|
+        attendee[attribute].downcase == criteria.downcase
+      end
+    end
+
+    def add(instructions)
+      attribute, criteria = parse_maths_input(instructions)
+      @cache.queue |= search('all', attribute, criteria)
+    end
+
+    def parse_maths_input(instructions)
+      if instructions.length != 2
+        throw(:top, "Incorrect add/subtract input")
+      elsif @cache.queue.empty?
+        throw(:top, "Can't add/subtract from an empty queue, silly!")
+      end
+
+      attribute, criteria = instructions[0], instructions[1]
+      validate_input(attribute, criteria)
+      return attribute, criteria
+    end
+  end
+end

data/lib/event_reporter/parse_input.rb

@@ -0,0 +1,9 @@
+module EventReporter
+  module ParseInput
+    def parse_input(input)
+      command = input[0] || []
+      leftovers = input[1..-1] || []
+      return command, leftovers
+    end
+  end
+end

data/lib/event_reporter/print.rb

@@ -0,0 +1,75 @@
+module EventReporter
+  module Print
+    class << self
+      def find_column_lengths(queue)
+        queue.inject(new_length_hash) do |column_length, attendee|
+          HEADERS.each do |header|
+            header = header.to_sym
+
+            if attendee[header].length > column_length[header]
+              column_length[header] = attendee[header].length
+            end
+          end
+
+          column_length
+        end
+      end
+
+      def new_length_hash
+        HEADERS.inject({}) do |column_length, header|
+          column_length[header.to_sym] = header.length
+          column_length
+        end
+      end
+
+      def queue_print(queue)
+        if queue.empty? 
+          puts "Nothing in queue!"
+        else
+          columns_length = find_column_lengths(queue)
+          print_headers(columns_length)
+          print_contents(columns_length, queue)
+        end
+      end
+
+      def print_headers(columns_length)
+        HEADERS.each do |header|
+          column_width = columns_length[header.to_sym]
+          print "#{header.gsub("_", " ").upcase.ljust(column_width)} "
+        end
+        print "\n"
+      end
+
+      def print_contents(columns_length, queue)
+        queue.each_with_index do |attendee, i|
+          i+=1
+          HEADERS.each do |header|
+            column_width = columns_length[header.to_sym]
+            print "#{attendee[header].ljust(column_width)} "
+          end
+          print "\n"
+          print_status(i, queue)
+        end
+      end
+
+      def print_status(i, queue)
+        if i % 10 == 0 && i != 0
+          puts "Showing Matches #{i-9}-#{i} of #{queue.length}"
+          AcceptAnyInput.read_char
+        end
+      end
+
+      def queue_print_by(attribute, queue)
+        if attribute.nil? || !queue.first.respond_to?(attribute)
+          throw(:top, "Attribute not found to print by...")
+        end
+
+        queue.sort! do |attendee1, attendee2|
+          attendee1[attribute] <=> attendee2[attribute]
+        end
+        
+        queue_print(queue)
+      end
+    end
+  end
+end

data/lib/event_reporter/runner.rb

@@ -0,0 +1,79 @@
+require 'event_reporter/parse_input'
+require 'event_reporter/database'
+require 'event_reporter/print'
+require 'event_reporter/save'
+require 'event_reporter/csv_parser'
+require 'event_reporter/cleaners'
+require 'event_reporter/attendee'
+require 'event_reporter/cache'
+require 'event_reporter/accept_any_input'
+
+require 'CSV'
+require 'yaml'
+require 'json'
+require 'nokogiri'
+
+module EventReporter
+
+  HEADERS = ["last_name", "first_name", "email",
+             "zipcode", "city", "state", "address", "phone_number"]
+
+  class Runner
+    include ParseInput
+
+    def initialize
+      puts "EventManager initializing..."
+      @database = Database.new
+      run_loop
+    end
+
+    private
+
+      def run_loop
+        loop do
+          message = catch(:top) do
+            route_input(user_input)
+          end
+          puts message unless message.nil? || !message.kind_of?(String)
+        end
+      end
+
+      def user_input
+        print "> "
+        return gets.chomp.downcase.split(" ")
+      end
+
+      def route_input(input)
+        command, leftovers = parse_input(input)
+        case command
+        when 'quit' then puts "Ciao, bella!\n\n"; exit
+        when 'help' then route_help(leftovers)
+        when 'load' then @database.load_csv(leftovers)
+        when 'find' then @database.route_find('all', leftovers)
+        when 'queue' then @database.route_queue(leftovers)
+        when 'subtract' then @database.subtract(leftovers)
+        when 'add' then @database.add(leftovers)
+        else
+          throw(:top, "Unknown input. Try 'help'")
+        end
+      end
+
+      def route_help(input)
+        help_contents = load_help_text
+        if input.empty?
+          help_contents.each { |key, value| puts value }
+        else
+          type = input.join("_")
+          if help_contents.include? type
+            puts help_contents[type]
+          else
+            throw(:top, "Unknown help command '#{input.join(" ")}'")
+          end
+        end
+      end
+
+      def load_help_text
+        YAML.load_file('bin/help.yml')
+      end
+  end
+end

data/lib/event_reporter/save.rb

@@ -0,0 +1,102 @@
+module EventReporter
+  module Save
+    class << self
+      def route_save_to(filename, queue)
+        throw(:top, "Please enter a filename to save to") if filename.nil?
+        
+        extension = filename.split(".")[1]
+        method = "save_to_#{extension}"
+        
+        if respond_to? method
+          send(method, filename, queue)
+        else
+          throw(:top, "Extension not valid! (try .csv, .xml, .txt, .json)")
+        end
+      end
+
+      def save_to_csv(filename, queue)
+        CSV.open("bin/#{filename}", "w") do |csv|
+          csv << HEADERS.map do |header|
+            header.downcase == 'phone_number' ? 'HomePhone' : header
+          end
+          queue.each do |attendee| 
+            csv << [attendee.last_name,
+                    attendee.first_name,
+                    attendee.email,
+                    attendee.zipcode,
+                    attendee.city,
+                    attendee.state, 
+                    attendee.address,
+                    attendee.phone_number]
+          end
+        end
+        success(filename)
+      end
+
+      def save_to_txt(filename, queue)
+        columns_length = Print.find_column_lengths(queue)
+        File.open("bin/#{filename}", "w") do |txt|
+          save_to_txt_headers(txt, columns_length)
+          save_to_txt_contents(txt, columns_length, queue)
+        end
+        success(filename)
+      end
+
+      def save_to_txt_headers(txt, columns_length)
+        HEADERS.each do |header|
+          column_width = columns_length[header.to_sym]
+          txt.print "#{header.gsub("_", " ").upcase.ljust(column_width)} "
+        end
+      end
+
+      def save_to_txt_contents(txt, columns_length, queue)
+        queue.each_with_index do |attendee, i|
+          HEADERS.each do |header|
+            column_width = columns_length[header.to_sym]
+            txt.print "#{attendee[header].ljust(column_width)} "
+          end
+        end    
+      end
+
+      def save_to_json(filename, queue)
+        File.open("bin/#{filename}", "w") do |json|
+          json.puts queue.to_json
+        end
+        success(filename)
+      end
+
+      def save_to_xml(filename, queue)
+        queue_xml = Nokogiri::XML::Builder.new do |xml|
+          xml.root {
+            xml.event_attendees {
+              build_attendees_xml(xml, queue)
+            }
+          }
+        end
+        File.open("bin/#{filename}", "w") do |xml|
+          xml.puts queue_xml.to_xml
+        end
+        success(filename)
+      end
+
+      def success(filename)
+        puts "Saved to #{filename}"
+      end
+
+      def build_attendees_xml(xml, queue)
+        queue.each do |attendee|
+          xml.attendee {
+            xml.first_name attendee.first_name
+            xml.last_name attendee.last_name
+            xml.email attendee.email
+            xml.phone_number attendee.phone_number
+            xml.address attendee.address
+            xml.city attendee.city
+            xml.state attendee.state
+            xml.zipcode attendee.zipcode
+          }
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: event_reporter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Raphael Weiner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "\n    Allows for inspection, filtering, printing and saving of csv
+  containing\n    list of event attendees through CLI.\n  "
+email: raphael.weiner@gmail.com
+executables:
+- event_reporter
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/event_attendees.csv
+- bin/event_reporter
+- bin/help.yml
+- lib/event_reporter/accept_any_input.rb
+- lib/event_reporter/attendee.rb
+- lib/event_reporter/cache.rb
+- lib/event_reporter/cleaners.rb
+- lib/event_reporter/csv_parser.rb
+- lib/event_reporter/database.rb
+- lib/event_reporter/parse_input.rb
+- lib/event_reporter/print.rb
+- lib/event_reporter/runner.rb
+- lib/event_reporter/save.rb
+- README.md
+- LICENSE
+- event_reporter.gemspec
+homepage: http://github.com/raphweiner/event_reporter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Loads csv of event attendees and allows for searching
+test_files: []