csv_find 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fad9ba988bfb458d1f4cf9d27d4b3b6ff1fa97ef
+  data.tar.gz: e648ecab510c2f0c439ce25d8ba05ab7831b4ec6
+SHA512:
+  metadata.gz: ecb6a2486aa3c178e583914a02930d31b5cbd1656791fccaf2aa1536db80620129184320ab26dc979e70f012e1a60060b239e57052cb7b7154da4a7a2424fa8a
+  data.tar.gz: 08689bf0756703c741e416f5f5174851959300cd47849b5c1c3ecececbf891b97b5551e159392cc8a9257ef7079cdfa769e4dc2e7c4b6a3735f65d0c4a0e9c26

data/lib/csv_find/csv_find.rb

@@ -0,0 +1,165 @@
+module CsvFind
+  require 'csv'
+
+  VERSION = {
+    major: '0',
+    minor: '0',
+    patch: '1'
+  }.values.join('.')
+
+  def self.included(base)
+    base.send :extend, ClassMethods
+    base.send :prepend, InstanceMethods
+  end
+
+  module InstanceMethods
+    attr_accessor :line_number
+
+    def initialize(hash = {})
+      hash.each { |k,v| send("#{k}=".to_sym, v) }
+    end
+
+    def ==(other_instance)
+      instance_variables.map do |instance_variable|
+        instance_variable_get(instance_variable) ==
+          other_instance.instance_variable_get(instance_variable)
+      end
+    end
+
+    private
+
+    attr_reader :hash
+  end
+
+  module ClassMethods
+    include Enumerable
+
+    attr_reader :headers, :file, :file_options,
+                :first_line, :middle_line, :last_line
+
+    def csv_file(file_name, options = {})
+      @file_options = default_options.merge(options)
+      @file = CSV.new(File.open(file_name, 'r'), @file_options)
+      @first_line = 2
+      @last_line = `wc -l #{file_name}`.split(' ').first.to_i
+      @middle_line = (@last_line/2) + 1
+      @line_number = nil
+      @headers = extract_headers(file_name, file_options)
+
+      define_accessors
+    end
+
+    def define_accessors
+      headers.each do |header|
+        send(:attr_accessor, header)
+      end
+    end
+
+    def all
+      rewind
+      file.map { |row| build_instance(row, file.lineno) }
+    end
+
+    def where(key_val_pair)
+      search(key_val_pair).map { |row| build_instance(row, row[:line_number]) }
+    end
+
+    def find_by(key_val_pair)
+      warn DEPRECATION_MESSAGE
+      row = search(key_val_pair).last
+      row.nil? ? nil : build_instance(row, row[:line_number])
+    end
+
+    def find_all_by(key_val_pair)
+      warn DEPRECATION_MESSAGE
+      where(key_val_pair)
+    end
+
+    def find(line_number)
+      row = if (first_line..middle_line).include?(line_number)
+        front_find(line_number, file.path)
+      else
+        back_find(line_number, file.path)
+      end
+
+      row.nil? ? row : build_instance(row, line_number)
+    end
+
+    def first
+      rewind
+      build_instance(file.first, first_line)
+    end
+
+    def last
+      command = `head -n 1 #{file.path} && tail -n 1 #{file.path}`
+      last_row = CSV.new(command, file_options).first
+      build_instance(last_row, last_line)
+    end
+
+    def each
+      rewind
+      (first_line..last_line).each do |line_number|
+        yield find(line_number) if block_given?
+      end
+    end
+
+    private
+
+    DEPRECATION_MESSAGE =
+      '[DEPRECATION] This method is deprecated and will be removed in v2.' <<
+      'Please user #where.'
+
+    def default_options
+      {
+        headers: true,
+        header_converters: :symbol,
+        return_headers: false
+      }
+    end
+
+    def extract_headers(file_name, options)
+      csv_file = File.open(file_name,'r')
+      CSV.new(csv_file, options).first.headers
+    end
+
+    def build_instance(row, line)
+      new_instance = new
+      row.each { |key, value| new_instance.send("#{key}=".to_sym, value) }
+      new_instance.line_number = line
+
+      new_instance
+    end
+
+    def rewind
+      file.rewind
+    end
+
+    def search(key_val_pair)
+      rewind
+      @results = file
+      @pairs = key_val_pair
+
+      @pairs.each { |pair| @results = dig(pair, @results) }
+
+      @results
+    end
+
+    def dig(hash_pair, rows)
+      rows.select do |row|
+        if row[hash_pair.first] == hash_pair.last
+          $. != last_line ? row.push(line_number: $.) : row
+        end
+      end
+    end
+
+    def front_find(line_number, file_path)
+      command = `head -n 1 #{file_path} && head -n #{line_number} #{file_path} | tail -n 1`
+      CSV.new(command, file_options).first
+    end
+
+    def back_find(line_number, file_path)
+      command = `head -n 1 #{file_path} && tail -n #{(last_line + 1) - line_number} #{file_path} | head -n 1`
+      CSV.new(command, file_options).first
+    end
+  end
+end

data/spec/csv_find_spec.rb

@@ -0,0 +1,103 @@
+require './lib/csv_find'
+
+class People
+  include CsvFind
+  csv_file('spec/support/demo.csv', {})
+end
+
+describe People do
+  before(:all){
+    @person1 = People.new(first: 'Mark', last: 'Platt', nickname: 'JCool', line_number: 2)
+    @person2 = People.new(first: 'Longinus', last: 'Smith', nickname: 'Pebbles', line_number: 3)
+    @person3 = People.new(first: 'Johnny', last: 'Radiation', nickname: 'Pebbles', line_number: 4)
+    @person4 = People.new(first: 'Charlie', last: 'Mansfield', nickname: 'Sammykins', line_number: 5)
+  }
+
+  context 'class methods' do
+    it "responds to .first" do
+      (People).should respond_to(:first)
+    end
+
+    it ".first returns correctly" do
+      expect(People.first).to eq @person1
+    end
+
+    it "responds to .last" do
+      (People).should respond_to(:last)
+    end
+
+    it ".last returns correctly" do
+      expect(People.last).to eq @person4
+    end
+
+    it "responds to .find" do
+      (People).should respond_to(:find)
+    end
+
+    it ".find returns correctly" do
+      expect(People.find(2)).to eq @person1
+      expect(People.find(3)).to eq @person2
+      expect(People.find(4)).to eq @person3
+      expect(People.find(5)).to eq @person4
+    end
+
+    it "[DEPRECATED] responds to .find_by" do
+      (People).should respond_to(:find_by)
+    end
+
+    it "[DEPRECATED] .find_by returns correctly" do
+      expect(People.find_by(nickname: 'Pebbles')).to eq @person3
+      expect(People.find_by(nickname: 'Pebbles', last: 'Smith')).to eq @person2
+    end
+
+    it ".find_by returns an nil if there are no results" do
+      expect(People.find_by(nickname: 'Beastmode')).to eq nil
+    end
+
+
+    it "responds to .where" do
+      (People).should respond_to(:where)
+    end
+
+    it ".where returns correctly" do
+      expect(People.where(nickname: 'Pebbles')).to eq [@person2, @person3]
+      expect(People.where(nickname: 'Pebbles', last: 'Radiation')).to eq [@person3]
+    end
+
+    it ".where returns an empty array if there are no results" do
+      expect(People.where(nickname: 'Beastmode')).to eq []
+    end
+
+    it "[DEPRECATED] responds to .find_all_by" do
+      (People).should respond_to(:find_all_by)
+    end
+
+    it "[DEPRECATED] .find_all_by returns correctly" do
+      expect(People.find_all_by(nickname: 'Pebbles')).to eq [@person2, @person3]
+      expect(People.find_all_by(nickname: 'Pebbles', last: 'Radiation')).to eq [@person3]
+    end
+
+    it "responds to .each" do
+      (People).should respond_to(:each)
+    end
+
+    it ".each line yields" do
+      @output = []
+      People.each{ |person| @output << person.first }
+      expect(@output).to eq ['Mark', 'Longinus', 'Johnny', 'Charlie']
+    end
+  end
+  context 'instance methods' do
+    it "responds to .first as defined in the csv" do
+      (People.new).should respond_to(:first)
+    end
+
+    it "responds to .last as defined in the csv" do
+      (People.new).should respond_to(:last)
+    end
+
+    it "responds to .nickname as defined in the csv" do
+      (People.new).should respond_to(:nickname)
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: csv_find
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Platt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: "'csv_find will blah blah blah'"
+email: mplatt@mrkplt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/csv_find/csv_find.rb
+- spec/csv_find_spec.rb
+homepage: http://mrkplt.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: "'blah'"
+test_files:
+- spec/csv_find_spec.rb