FarMar w/optional requirements I and II

lib/far_mar.rb

@@ -1,7 +1,10 @@
 require 'csv'
 require 'time'
+require 'pry'
 
 # Order matters here so I might have to change it
+require './lib/far_mar/far_mar_base'
+require './lib/far_mar/vend_prod_base'
 require './lib/far_mar/market'
 require './lib/far_mar/vendor'
 require './lib/far_mar/product'

lib/far_mar/far_mar_base.rb

@@ -0,0 +1,43 @@
+module FarMar
+  class FarMar_Base
+    def initialize(init_hash)
+      # This block sets each key to an instance variable and assigns the value
+      init_hash.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    def self.all
+      if !self.class_variable_defined?(:@@all_objects)
+        csv_file = CSV.read(self::FILENAME)
+        # Create empty array which will hold all the objects
+        objects = []
+        csv_file.each do |row|
+          # Convert the array to a hash
+          csv_hash = self.convert_to_hash(row)
+          # Create an object from each row-hash in the csv file
+          temp = self.new(csv_hash)
+          # Push object to array of products
+          objects.push(temp)
+        end
+        self.class_variable_set(:@@all_objects, objects)
+      end
+      self.all_objects
+    end
+
+    def self.find(id)
+      self.all_objects.find { |obj| obj.id == id }
+    end
+
+    # returns a single instance whose attribute matches the parameter
+    def self.find_by_name(match)
+      return nil if match.class != String
+      result = FarMar::Vendor.all_objects.find do |vendor|
+        test_string = vendor.name.downcase
+        test_string.include?(match.downcase)
+      end
+      return result
+    end
+
+  end
+end

lib/far_mar/market.rb

@@ -1,5 +1,93 @@
 module FarMar
-  class Market
+  class Market < FarMar_Base
+    attr_reader :id, :name, :address, :city, :county, :state, :zip
+    FILENAME = './support/markets.csv'
+
+    def initialize(market_hash)
+      super(market_hash)
+    end
+
+    def self.all_objects
+      @@all_objects ||= self.all
+    end
+
+    # Converts an array to a hash for passing to market instantiation
+    def self.convert_to_hash(market_array)
+      market_hash = {}
+      market_hash[:id] = market_array[0].to_i
+      market_hash[:name] = market_array[1]
+      market_hash[:address] = market_array[2]
+      market_hash[:city] = market_array[3]
+      market_hash[:county] = market_array[4]
+      market_hash[:state] = market_array[5]
+      market_hash[:zip] = market_array[6]
+      return market_hash
+    end
+
+    # Returns a collection of FarMar::Market instances where the market name
+    # or vendor name contain the search_term
+    def self.search(search_term)
+      return [] if search_term.class != String
+      search_term.downcase!
+      # find all markets that include the search term in the market name
+      market_match = FarMar::Market.all_objects.select do |market|
+        market_name = market.name.downcase
+        market_name.include?(search_term)
+      end
+      # find all markets that have the search term in the vendor name
+      vendor_match = FarMar::Vendor.all_objects.select do |vendor|
+        vendor_name = vendor.name.downcase
+        vendor_name.include?(search_term)
+      end
+      # This iterates through the vendors that include the search term
+      vendor_match.each do |vendor|
+        # and finds their associated market based on the market_id
+        market = FarMar::Market.find(vendor.market_id)
+        # then checks to see if the market is already in the market_match array
+        # and if not, it pushes it into the array
+        market_match.push(market) if !market_match.include?(market)
+      end
+      return market_match
+    end
+
+    # Returns a collection of FarMar::Vendor instances that are associated
+    # with the market by the market_id field
+    def vendors
+      return FarMar::Vendor.by_market(@id)
+    end
+
+    # returns a collection of FarMar::Product instances that are associated
+    # to the market through the FarMar::Vendor class
+    def products
+      products = []
+      v = vendors
+      v.each do |vendor|
+        products += vendor.products
+      end
+      return products
+    end
+
+    # returns the vendor with the highest revenue for the given date
+    # or returns the vendor with the highest revenue if no date is given
+    def preferred_vendor(date = nil)
+      return vendors.max_by { |vend| vend.revenue } if date.nil?
+      return nil if date.class != DateTime
+      m_vendors = vendors
+      rev = m_vendors.map { |vend| vend.day_revenue(date) }
+      max_index = rev.each_with_index.max[1]
+      return m_vendors[max_index]
+    end
+
+    # returns the vendor with the lowest revenue on the given date
+    # or returns the vendor with the lowest revenue if no date is given
+    def worst_vendor(date = nil)
+      return vendors.min_by { |vend| vend.revenue } if date.nil?
+      return nil if date.class != DateTime
+      m_vendors = vendors
+      rev = m_vendors.map { |vend| vend.day_revenue(date) }
+      min_index = rev.each_with_index.min[1]
+      return m_vendors[min_index]
+    end
 
   end
 end

lib/far_mar/product.rb

@@ -1,5 +1,57 @@
 module FarMar
-  class Product
+  class Product < FarMar_Base
+    attr_reader :id, :name, :vendor_id
+    FILENAME = './support/products.csv'
+    REV_ATTR = :@@product_stats # the attribute accessed by the revenue method
 
+    # include adds methods to the instance of a class
+    # in this case, revenue is an instance method that is included
+    include VendorProductBase
+
+    def initialize(product_hash)
+      super(product_hash)
+      @revenue = revenue
+    end
+
+    def self.all_objects
+      @@all_objects ||= self.all
+    end
+
+    # Converts an array to a hash for passing to product instantiation
+    def self.convert_to_hash(product_array)
+      product_hash = {}
+      product_hash[:id] = product_array[0].to_i
+      product_hash[:name] = product_array[1]
+      product_hash[:vendor_id] = product_array[2].to_i
+      return product_hash
+    end
+
+    # returns all of the products with the given vendor_id
+    def self.by_vendor(vendor_id)
+      FarMar::Product.all_objects.find_all { |product| product.vendor_id == vendor_id }
+    end
+
+    # returns the top n products instances ranked by total revenue
+    def self.most_revenue(n)
+      most_x(n, "@revenue")
+      # FarMar::VendorProductBase.class_method(:most_x).bind(self).call(n, "@revenue")
+    end
+
+    # returns the FarMar::Vendor instance that is associated with this
+    # vendor using the vendor_id field
+    def vendor
+      return FarMar::Vendor.find(@vendor_id)
+    end
+
+    # returns a collection of FarMar::Sale instances that are associated using
+    # the product_id field
+    def sales
+      return FarMar::Sale.by_product(@id)
+    end
+
+    # returns the number of times the product has been sold
+    def number_of_sales
+      return sales.length
+    end
   end
 end

lib/far_mar/sale.rb

@@ -1,5 +1,99 @@
 module FarMar
-  class Sale
+  class Sale < FarMar_Base
+    attr_reader :id, :amount, :purchase_time, :vendor_id, :product_id
+    FILENAME = './support/sales.csv'
 
+    def initialize(sale_hash)
+      super(sale_hash)
+    end
+
+    def self.all_objects
+      @@all_objects ||= self.all[0]
+    end
+
+    def self.vendor_stats
+      @@vendor_stats ||= self.all[1]
+    end
+
+    def self.product_stats
+      @@product_stats ||= self.all[2]
+    end
+
+    def self.all
+      if !self.class_variable_defined?(:@@all_objects) ||!self.class_variable_defined?(:@@vendor_stats)
+        csv_file = CSV.read(FILENAME)
+        # Create empty array which will hold all the objects
+        objects = []
+        vend_stats = {}
+        prod_stats = {}
+        csv_file.each do |row|
+          # Convert the array to a hash
+          sale_hash = convert_to_hash(row)
+          # Create an object from each row-hash in the csv file
+          temp = self.new(sale_hash)
+          # Push object to array of products
+          objects.push(temp)
+          # Populate the vend_stats array
+          if vend_stats[sale_hash[:vendor_id]].nil? # if there is no revenue yet
+            vend_stats[sale_hash[:vendor_id]] = {}
+            vend_stats[sale_hash[:vendor_id]][:revenue] = sale_hash[:amount] # store the first revenue
+            vend_stats[sale_hash[:vendor_id]][:num_sales] = 1 # and tally 1 for number of sales
+          else
+            vend_stats[sale_hash[:vendor_id]][:revenue] += sale_hash[:amount] # add the amount to the revenue
+            vend_stats[sale_hash[:vendor_id]][:num_sales] += 1 # and add 1 to sale tally
+          end
+          # Populate product_stats array
+          if prod_stats[sale_hash[:product_id]].nil? # if there is no product revenue yet
+            prod_stats[sale_hash[:product_id]] = {}
+            prod_stats[sale_hash[:product_id]][:revenue] = sale_hash[:amount] # stores the first revenue
+          else
+            prod_stats[sale_hash[:product_id]][:revenue] += sale_hash[:amount] # adds the amount to the revenue
+          end
+        end
+        return self.class_variable_set(:@@all_objects, objects), self.class_variable_set(:@@vendor_stats, vend_stats), self.class_variable_set(:@@product_stats, prod_stats)
+
+      end
+      self.all_objects
+    end
+
+    def self.convert_to_hash(sale_array)
+      sale_hash = {}
+      sale_hash[:id] = sale_array[0].to_i
+      sale_hash[:amount] = sale_array[1].to_i
+      sale_hash[:purchase_time] = DateTime.parse(sale_array[2])
+      sale_hash[:vendor_id] = sale_array[3].to_i
+      sale_hash[:product_id] = sale_array[4].to_i
+      return sale_hash
+    end
+
+    # returns all of the sales with the given product id
+    def self.by_product(product_id)
+      return FarMar::Sale.all_objects.find_all { |sale| sale.product_id == product_id }
+    end
+
+    # returns all of the sales with the given vendor id
+    def self.by_vendor(vendor_id)
+      return FarMar::Sale.all_objects.find_all { |sale| sale.vendor_id == vendor_id }
+    end
+
+    # returns a collection of FarMar::Sale objects where the purchase time
+    # is between the two times given as arguments
+    def self.between(beginning_time, end_time)
+      return [] if
+        beginning_time.class != DateTime ||
+        end_time.class != DateTime ||
+        end_time <= beginning_time
+      return FarMar::Sale.all_objects.find_all { |sale_obj| sale_obj.purchase_time > beginning_time && sale_obj.purchase_time < end_time }
+    end
+
+    # returns the Vendor that is associated with the sale
+    def vendor
+      return FarMar::Vendor.find(@vendor_id)
+    end
+
+    # returns the Product that is associated with the sale
+    def product
+      return FarMar::Product.find(@product_id)
+    end
   end
 end

lib/far_mar/vend_prod_base.rb

@@ -0,0 +1,34 @@
+module FarMar
+  module VendorProductBase
+    # info from http://www.railstips.org/blog/archives/2009/05/15/include-vs-extend-in-ruby/
+    def self.included(base)
+      # extend is for adding class methods
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # these are class methods for the VendorProductBase module
+      # written this way so that "self" refers to the class that is calling it
+      # self is either FarMar::Vendor or FarMar::Product
+      def most_x(n, attribute)
+        return [] if
+          n.class != Fixnum ||
+          n < 0 ||
+          n > self.all_objects.length
+        backwards = self.all_objects.sort_by { |obj| obj.instance_variable_get(attribute) }
+        sorted = backwards.reverse
+        return sorted[0, n]
+      end
+    end
+
+    def revenue
+      return @revenue if [email protected]?
+      results = FarMar::Sale.class_variable_get(self.class::REV_ATTR)
+      if results[@id].nil?
+        @revenue = 0
+      else
+        @revenue = results[@id][:revenue]
+      end
+    end
+  end
+end