csv_find 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fad9ba988bfb458d1f4cf9d27d4b3b6ff1fa97ef
-  data.tar.gz: e648ecab510c2f0c439ce25d8ba05ab7831b4ec6
+SHA256:
+  metadata.gz: 2b108651a75a452e5eb1cd0baf8ea4b3203d1de7c5c1481f2cb8a5b6a872a775
+  data.tar.gz: 91b761d46c8d1d633db45e34e79b3d97258aa56c4664e7e6406d49015b64bf0c
 SHA512:
-  metadata.gz: ecb6a2486aa3c178e583914a02930d31b5cbd1656791fccaf2aa1536db80620129184320ab26dc979e70f012e1a60060b239e57052cb7b7154da4a7a2424fa8a
-  data.tar.gz: 08689bf0756703c741e416f5f5174851959300cd47849b5c1c3ecececbf891b97b5551e159392cc8a9257ef7079cdfa769e4dc2e7c4b6a3735f65d0c4a0e9c26
+  metadata.gz: 8c394b06f9316d894e2b025265212efde56bcaa1a4a016b0fc0f296f96b0c05d925b43d209c7e305ccc8482e53de179295806c3f57643621105f56d0e5ae58d4
+  data.tar.gz: e85c5055eed62026a762f36cf5c1b956c774c06e54157d27530fa1b88c94e6809655522c7913f1cfd4baa86737c40a7fb49b830f800435253809116c02a0a099

data/lib/csv_find/csv_find.rb

@@ -1,10 +1,14 @@
-module CsvFind
+# frozen_string_literal: true
+
+require 'English'
+
+module CsvFind #:nodoc:
   require 'csv'
 
   VERSION = {
-    major: '0',
+    major: '1',
     minor: '0',
-    patch: '1'
+    patch: '0'
   }.values.join('.')
 
   def self.included(base)
@@ -12,17 +16,17 @@ module CsvFind
     base.send :prepend, InstanceMethods
   end
 
-  module InstanceMethods
+  module InstanceMethods #:nodoc:
     attr_accessor :line_number
 
     def initialize(hash = {})
-      hash.each { |k,v| send("#{k}=".to_sym, v) }
+      hash.each { |k, v| send("#{k}=".to_sym, v) }
     end
 
-    def ==(other_instance)
+    def ==(other)
       instance_variables.map do |instance_variable|
         instance_variable_get(instance_variable) ==
-          other_instance.instance_variable_get(instance_variable)
+          other.instance_variable_get(instance_variable)
       end
     end
 
@@ -31,7 +35,7 @@ module CsvFind
     attr_reader :hash
   end
 
-  module ClassMethods
+  module ClassMethods #:nodoc:
     include Enumerable
 
     attr_reader :headers, :file, :file_options,
@@ -39,10 +43,10 @@ module CsvFind
 
     def csv_file(file_name, options = {})
       @file_options = default_options.merge(options)
-      @file = CSV.new(File.open(file_name, 'r'), @file_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
+      @middle_line = (@last_line / 2) + 1
       @line_number = nil
       @headers = extract_headers(file_name, file_options)
 
@@ -65,22 +69,21 @@ module CsvFind
     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 =
+        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
@@ -92,7 +95,7 @@ module CsvFind
 
     def last
       command = `head -n 1 #{file.path} && tail -n 1 #{file.path}`
-      last_row = CSV.new(command, file_options).first
+      last_row = CSV.new(command, **file_options).first
       build_instance(last_row, last_line)
     end
 
@@ -105,10 +108,6 @@ module CsvFind
 
     private
 
-    DEPRECATION_MESSAGE =
-      '[DEPRECATION] This method is deprecated and will be removed in v2.' <<
-      'Please user #where.'
-
     def default_options
       {
         headers: true,
@@ -118,8 +117,8 @@ module CsvFind
     end
 
     def extract_headers(file_name, options)
-      csv_file = File.open(file_name,'r')
-      CSV.new(csv_file, options).first.headers
+      csv_file = File.open(file_name, 'r')
+      CSV.new(csv_file, **options).first.headers
     end
 
     def build_instance(row, line)
@@ -147,19 +146,24 @@ module CsvFind
     def dig(hash_pair, rows)
       rows.select do |row|
         if row[hash_pair.first] == hash_pair.last
-          $. != last_line ? row.push(line_number: $.) : row
+          $NR != last_line ? row.push(line_number: $NR) : 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
+    def front_find(line_number, path)
+      command =
+        `head -n 1 #{path} && head -n #{line_number} #{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
+    def back_find(line_number, path)
+      mid = (last_line + 1) - line_number
+      command =
+        `head -n 1 #{path} && tail -n #{mid} #{path} | head -n 1`
+
+      CSV.new(command, **file_options).first
     end
   end
 end

data/spec/csv_find_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require './lib/csv_find'
 
 class People
@@ -6,98 +8,125 @@ class People
 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)
-  }
+  before(:all)  do
+    @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
+    )
+  end
 
   context 'class methods' do
-    it "responds to .first" do
-      (People).should respond_to(:first)
+    it 'responds to .first' do
+      expect(People).to respond_to(:first)
     end
 
-    it ".first returns correctly" do
+    it '.first returns correctly' do
       expect(People.first).to eq @person1
     end
 
-    it "responds to .last" do
-      (People).should respond_to(:last)
+    it 'responds to .last' do
+      expect(People).to respond_to(:last)
     end
 
-    it ".last returns correctly" do
+    it '.last returns correctly' do
       expect(People.last).to eq @person4
     end
 
-    it "responds to .find" do
-      (People).should respond_to(:find)
+    it 'responds to .find' do
+      expect(People).to respond_to(:find)
     end
 
-    it ".find returns correctly" do
+    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)
+    it '[DEPRECATED] responds to .find_by' do
+      expect(People).to respond_to(:find_by)
     end
 
-    it "[DEPRECATED] .find_by returns correctly" do
+    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
+    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)
+    it 'responds to .where' do
+      expect(People).to respond_to(:where)
     end
 
-    it ".where returns correctly" do
+    it '.where returns correctly' do
       expect(People.where(nickname: 'Pebbles')).to eq [@person2, @person3]
-      expect(People.where(nickname: 'Pebbles', last: 'Radiation')).to eq [@person3]
+      expect(People.where(nickname: 'Pebbles', last: 'Radiation'))
+        .to eq [@person3]
     end
 
-    it ".where returns an empty array if there are no results" do
+    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)
+    it '[DEPRECATED] responds to .find_all_by' do
+      expect(People).to 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]
+    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)
+    it 'responds to .each' do
+      expect(People).to respond_to(:each)
     end
 
-    it ".each line yields" do
+    it '.each line yields' do
       @output = []
-      People.each{ |person| @output << person.first }
-      expect(@output).to eq ['Mark', 'Longinus', 'Johnny', 'Charlie']
+      People.each { |person| @output << person.first }
+      expect(@output).to eq %w[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)
+    it 'responds to .first as defined in the csv' do
+      expect(People.new).to respond_to(:first)
     end
 
-    it "responds to .last as defined in the csv" do
-      (People.new).should respond_to(:last)
+    it 'responds to .last as defined in the csv' do
+      expect(People.new).to respond_to(:last)
     end
 
-    it "responds to .nickname as defined in the csv" do
-      (People.new).should respond_to(:nickname)
+    it 'responds to .nickname as defined in the csv' do
+      expect(People.new).to respond_to(:nickname)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv_find
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Mark Platt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2020-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,15 +16,29 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.9.0
   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'"
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+description: csv_find quickly finds rows and creates an instance with that data
 email: mplatt@mrkplt.com
 executables: []
 extensions: []
@@ -44,17 +58,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: "'blah'"
+summary: This uses some command line tools to take CSV's apart and put them together
+  to quickly find specific rows in a csv.
 test_files:
 - spec/csv_find_spec.rb