flicks 0.0.1 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9c38367cfaa556b1e96e5346eb160e96a73ebf7d2d77c2daf1660a06db25997
+  data.tar.gz: e4e6b31ca66a8995c45f2338554c5160685aebbfe2c663e2dc047a9fe83a79ab
+SHA512:
+  metadata.gz: 0714c420bf2963ba9348792f5d2be432c95581f273246b599100e16b6a6e26d27e10ac876dec111b24383c03346531161b351414c71fa6bb59010b53da5142e0
+  data.tar.gz: 2f222ec25bf02517f40b32b722a517636a2d0759d03ec3537b56baa2a4797b1ad2d603c8376190183ef10710416f72af22be1f3620609ab87f8f3edb2db1dd4b

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,6 @@
-Copyright (c) 2012 The Pragmatic Studio
+The MIT License (MIT)
+
+Copyright (c) 2023 The Pragmatic Studio
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -8,8 +10,8 @@ copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
 - You may not use this Software in other training contexts.
-  
-- The above copyright notice and this permission notice shall be 
+
+- 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
@@ -18,4 +20,4 @@ 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.
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,22 @@
+# Flicks
+
+This is an example application used in The Pragmatic Studio's
+[Ruby video course](https://pragmaticstudio.com/courses/ruby).
+
+## Usage
+
+To run the example main program file, use:
+
+```sh
+flicks
+```
+
+You can also specify a CSV file with movie titles and ranks:
+
+```sh
+flicks my_movies.csv
+```
+
+## License
+
+This code is available as open source under the terms of the LICENSE.txt file.

data/bin/flicks

@@ -1,23 +1,27 @@
 #!/usr/bin/env ruby
 
-require_relative '../lib/flicks/playlist'
+require_relative "../lib/flicks/playlist"
 
-playlist = Flicks::Playlist.new("Kermit")
+playlist_1 = Flicks::Playlist.new("Kermit")
 
-playlist.load(ARGV.shift || File.join(File.dirname(__FILE__), 'movies.csv'))
+movies_file = File.join(__dir__, "movies.csv")
+
+playlist_1.load(ARGV.shift || movies_file)
 
 loop do
-  puts "\nHow many viewings? ('quit' to exit)"
+  print "\nHow many viewings? ('quit' to exit) "
+
   answer = gets.chomp.downcase
+
   case answer
   when /^\d+$/
-    playlist.play(answer.to_i)
-  when 'quit', 'exit'
-    playlist.print_stats
+    playlist_1.play(answer.to_i)
+  when "quit", "exit"
+    playlist_1.print_stats
     break
   else
     puts "Please enter a number or 'quit'"
   end
 end
 
-playlist.save
+playlist_1.save

data/bin/movies.csv

@@ -1,3 +1,3 @@
-Goonies,10
-Ghostbusters,9
-Goldfinger,5
+Arrival,10
+Gravity,9
+Interstellar,8

data/lib/flicks/movie.rb

@@ -1,44 +1,45 @@
-require_relative 'snack_bar'
-require_relative 'rankable'
+require_relative "rankable"
 
 module Flicks
   class Movie
     include Rankable
 
+    attr_reader :snacks_eaten
     attr_accessor :title, :rank
 
-    def initialize(title, rank=0)
+    def initialize(title, rank = 5)
       @title = title.capitalize
       @rank = rank
-      @snack_carbs = Hash.new(0)
+      @snacks_eaten = Hash.new(0)
     end
 
-    def ate_snack(snack)
-      @snack_carbs[snack.name] += snack.carbs
-      puts "#{@title} led to #{snack.carbs} #{snack.name} carbs being consumed."
+    def add_snack(name, price)
+      @snacks_eaten[name] += price
     end
 
-    def carbs_consumed    
-      @snack_carbs.values.reduce(0, :+)
+    def total_snack_price
+      @snacks_eaten.values.sum
     end
 
-    def each_snack
-      @snack_carbs.each do |name, carbs|
-        yield Snack.new(name,  carbs)
-      end
-    end
-
-    def to_s
-      "#{@title} has a rank of #{@rank} (#{status})"
+    def self.from_csv(line)
+      title, rank = line.split(",")
+      Movie.new(title, Integer(rank))
+    rescue ArgumentError
+      puts "Ignored invalid rank: #{rank}"
+      Movie.new(title)
     end
 
     def to_csv
       "#{@title},#{@rank}"
     end
 
-    def self.from_csv(string)
-      title, rank = string.split(',')    
-      new(title, Integer(rank))
+    def to_s
+      "#{@title} has a rank of #{@rank}"
     end
   end
-end
+end
+
+if __FILE__ == $0
+  movie = Movie.new("Star Wars", 10)
+  puts movie
+end

data/lib/flicks/movie3d.rb

@@ -1,20 +1,38 @@
-require_relative 'movie'
+require_relative "movie"
 
 module Flicks
   class Movie3D < Movie
-    attr_reader :wow_factor
 
-    def initialize(name, rank, wow_factor)
-      super(name, rank)
+    def initialize(title, rank, wow_factor)
+      super(title, rank)
       @wow_factor = wow_factor
     end
 
+    def show_effect
+      puts "Wow! " * @wow_factor
+    end
+
     def thumbs_up
       @wow_factor.times { super }
     end
 
-    def show_effect
-      puts "Wow! " * @wow_factor
-    end
   end
-end
+end
+
+if __FILE__ == $0
+
+  movie3d = Movie3D.new("godzilla", 7, 10)
+
+  puts movie3d.title
+  puts movie3d.rank
+
+  movie3d.show_effect
+
+  movie3d.thumbs_up
+
+  puts movie3d
+
+  puts Movie3D.superclass
+
+  p Movie3D.ancestors
+end

data/lib/flicks/playlist.rb

@@ -1,78 +1,98 @@
-require_relative 'movie'
-require_relative 'movie3d'
-require_relative 'waldorf_and_statler'
-require_relative 'snack_bar'
+require_relative "snackbar"
+require_relative "movie"
 
 module Flicks
   class Playlist
-    attr_reader :name
+
+    attr_reader :name, :movies
 
     def initialize(name)
       @name = name
       @movies = []
     end
 
-    def add_movie(a_movie)
-      @movies << a_movie
-    end
-
-    def play(viewings)
-      puts "#{@name}'s playlist:"
-
-      puts @movies.sort
-
-      snacks = SnackBar::SNACKS
-      puts "\nThere are #{snacks.size} snacks available in the snack bar:"
-      snacks.each do |snack|
-        puts "#{snack.name} has #{snack.carbs} carbs"
+    def load(from_file)
+      File.readlines(from_file, chomp: true).each do |line|
+        movie = Movie.from_csv(line)
+        add_movie(movie)
       end
+    rescue Errno::ENOENT
+      puts "Whoops, #{from_file} not found!"
+      exit 1
+    end
 
-      1.upto(viewings) do |count|
-        puts "\nViewing #{count}:"
-        @movies.each do |movie|
-          WaldorfAndStatler.review(movie)
-          snack = SnackBar.random
-          movie.ate_snack(snack)
-          puts movie
+    def save(to_file = "movie_rankings.csv")
+      File.open(to_file, "w") do |file|
+        sorted_movies.each do |movie|
+          file.puts movie.to_csv
         end
       end
     end
 
-    def total_carbs_consumed
-      @movies.reduce(0) { |sum, movie| sum + movie.carbs_consumed }
+    def add_movie(movie)
+      @movies << movie
     end
 
-    def print_stats
-      puts "\n#{@name}'s Stats:"
+    def roll_die
+      rand(1..6)
+    end
 
-      hits, flops = @movies.partition {|movie| movie.hit? }
+    def sorted_movies
+      @movies.sort_by { |movie| movie.rank }.reverse
+    end
 
-      puts "\nHits:"
-      puts hits.sort
+    def print_stats
+      puts "\n#{@name}'s Playlist Stats:"
+      puts "-" * 30
 
-      puts "\nFlops:"
-      puts flops.sort
+      puts sorted_movies
 
-      puts "\n#{total_carbs_consumed} total carbs consumed"    
-      @movies.sort.each do |movie|
-        puts "\n#{movie.title}'s snack totals:"
-        movie.each_snack do |snack|
-          puts "#{snack.carbs} total #{snack.name} carbs"
+      @movies.each do |movie|
+        puts "\n#{movie.title} snack totals:"
+        movie.snacks_eaten.each do |name, total_price|
+          puts "#{name}: $#{total_price}"
         end
-        puts "#{movie.carbs_consumed} grand total carbs"
+        puts "total: $#{movie.total_snack_price}"
       end
     end
 
-    def load(from_file)
-      File.readlines(from_file).each do |line|
-        add_movie(Movie.from_csv(line))
-      end
-    end
+    def play(viewings = 3)
+      puts "*" * 30
+      puts "#{@name}'s playlist:"
 
-    def save(to_file="movie_rankings.csv")
-      File.open(to_file, "w") do |file|
-        file.puts @movies.sort.map { |movie| movie.to_csv }
+      puts "\nThe snackbar has:"
+      menu_items = Snackbar.menu_items
+      puts menu_items
+
+      puts "\nBefore watching:"
+      puts @movies
+
+      1.upto(viewings) do |viewing_number|
+        puts "\nViewing #{viewing_number}:"
+
+        @movies.each do |movie|
+          number_rolled = roll_die
+
+          case number_rolled
+          when 1..2
+            movie.thumbs_down
+            puts "#{movie.title} got a 👎"
+          when 3..4
+            puts "#{movie.title} got skipped"
+          else
+            movie.thumbs_up
+            puts "#{movie.title} got a 👍"
+          end
+
+          snack = Snackbar.random_snack
+          movie.add_snack(snack.name, snack.price)
+          puts "During #{movie.title}, #{@name} at #{snack.name} for $#{snack.price}."
+        end
       end
+
+      puts "\nAfter watching:"
+      puts @movies
     end
+
   end
-end
+end

data/lib/flicks/rankable.rb

@@ -7,17 +7,5 @@ module Flicks
     def thumbs_down
       self.rank -= 1
     end
-
-    def hit?
-      self.rank >= 10
-    end 
-
-    def status
-      hit? ? "Hit": "Flop"
-    end
-
-    def <=>(other)
-      other.rank <=> self.rank
-    end
   end
-end
+end

data/lib/flicks/snackbar.rb

@@ -0,0 +1,21 @@
+module Flicks
+  module Snackbar
+    Snack = Data.define(:name, :price)
+
+    SNACKS = [
+      Snack.new("popcorn", 3),
+      Snack.new("candy", 1),
+      Snack.new("nachos", 4),
+      Snack.new("pretzels", 2)
+    ]
+
+    def self.random_snack
+      SNACKS.sample
+    end
+
+    def self.menu_items
+      SNACKS.map { |snack| "#{snack.name} for $#{snack.price}" }
+    end
+
+  end
+end

metadata

@@ -1,76 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: flicks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - The Pragmatic Studio
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-01-27 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70225081360240 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70225081360240
-description: ! "This is an example application used in The Pragmatic Studio's \nRuby
-  Programming course, as described at\n\n  http://pragmaticstudio.com\n\nThis code
-  is Copyright 2012 The Pragmatic Studio. See the LICENSE file."
+date: 2023-07-27 00:00:00.000000000 Z
+dependencies: []
+description:
 email: support@pragmaticstudio.com
 executables:
 - flicks
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
 - bin/flicks
 - bin/movies.csv
 - lib/flicks/movie.rb
 - lib/flicks/movie3d.rb
 - lib/flicks/playlist.rb
 - lib/flicks/rankable.rb
-- lib/flicks/snack_bar.rb
-- lib/flicks/waldorf_and_statler.rb
-- spec/flicks/movie3d_spec.rb
-- spec/flicks/movie_spec.rb
-- spec/flicks/playlist_spec.rb
-- spec/flicks/snack_bar_spec.rb
-- LICENSE
-- README
-homepage: http://pragmaticstudio.com
-licenses: []
-post_install_message: 
+- lib/flicks/snackbar.rb
+homepage: https://pragmaticstudio.com
+licenses:
+- MIT
+metadata: {}
+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'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.10
-signing_key: 
-specification_version: 3
-summary: Plays and reviews movies
-test_files:
-- spec/flicks/movie3d_spec.rb
-- spec/flicks/movie_spec.rb
-- spec/flicks/playlist_spec.rb
-- spec/flicks/snack_bar_spec.rb
+rubygems_version: 3.4.17
+signing_key:
+specification_version: 4
+summary: A command-line, randomized movie reviewer.
+test_files: []

data/README

@@ -1,6 +0,0 @@
-This is an example application used in The Pragmatic Studio's 
-Ruby Programming course, as described at
-
-  http://pragmaticstudio.com
-
-This code is Copyright 2012 The Pragmatic Studio. See the LICENSE file.

data/lib/flicks/snack_bar.rb

@@ -1,17 +0,0 @@
-module Flicks
-  Snack = Struct.new(:name, :carbs)
-
-  module SnackBar  
-    SNACKS = [ 
-      Snack.new(:nachos,  40),
-      Snack.new(:popcorn, 20),  
-      Snack.new(:candy,   15),
-      Snack.new(:pretzel, 10),
-      Snack.new(:soda,     5)
-    ]
-
-    def self.random
-      SNACKS.sample
-    end
-  end
-end

data/lib/flicks/waldorf_and_statler.rb

@@ -1,22 +0,0 @@
-require_relative 'movie'
-
-module Flicks
-  module WaldorfAndStatler 
-    def self.roll_die
-      rand(1..6)
-    end
-
-    def self.review(movie)
-      case roll_die
-      when 1..2
-        movie.thumbs_down
-        puts "#{movie.title} got a thumbs down."
-      when 3..4
-        puts "#{movie.title} was skipped."
-      else
-        movie.thumbs_up
-        puts "#{movie.title} got a thumbs up!"
-      end
-    end
-  end
-end

data/spec/flicks/movie3d_spec.rb

@@ -1,35 +0,0 @@
-require 'flicks/movie3d'
-
-module Flicks
-  describe Movie3D do
-    before do
-      @initial_rank = 10
-      @wow_factor = 5
-      @movie = Movie3D.new('Glee', @initial_rank, @wow_factor)
-    end
-  
-    it "has a title" do
-      @movie.title.should == "Glee"
-    end
-  
-    it "has a rank" do
-      @movie.rank.should == 10
-    end
-  
-    it "has a wow factor" do
-      @movie.wow_factor.should == 5
-    end
-  
-    it "increases rank by 1 times the wow factor when given a thumbs up" do
-      @movie.thumbs_up
-  
-      @movie.rank.should == @initial_rank + (1 * @wow_factor)
-    end
-
-    it "decreases rank by 1 when given a thumbs down" do
-      @movie.thumbs_down
-  
-      @movie.rank.should == @initial_rank - 1
-    end
-  end
-end

data/spec/flicks/movie_spec.rb

@@ -1,124 +0,0 @@
-require 'flicks/movie'
-
-module Flicks
-  describe Movie do
-    before do
-      @initial_rank = 10
-      @movie = Movie.new("goonies", @initial_rank)
-    end
-    
-    it "has a capitalized title" do
-      @movie.title.should == "Goonies"
-    end
-  
-    it "has an initial rank" do  
-      @movie.rank.should == 10
-    end
-  
-    it "has a string representation" do
-      @movie.to_s.should == "Goonies has a rank of 10 (Hit)"
-    end
-  
-    it "increases rank by 1 when given a thumbs up" do
-      @movie.thumbs_up
-    
-      @movie.rank.should == @initial_rank + 1
-    end
-  
-    it "decreases rank by 1 when given a thumbs down" do
-      @movie.thumbs_down
-    
-      @movie.rank.should == @initial_rank - 1
-    end
-  
-    context "created with a default rank" do
-      before do
-        @movie = Movie.new("goonies")
-      end
-    
-      it "has a rank of 0" do
-        @movie.rank.should == 0
-      end
-    end
-      
-    context "with a rank of at least 10" do
-      before do
-        @movie = Movie.new("goonies", 10)
-      end
-    
-      it "is a hit" do
-        @movie.should be_hit
-      end
-    
-      it "has a hit status" do
-        @movie.status.should == "Hit"
-      end
-    end
-  
-    context "with a rank less than 10" do
-      before do
-        @movie = Movie.new("goonies", 9)
-      end
-    
-      it "is not a hit" do
-        @movie.should_not be_hit
-      end
-    
-      it "has a flop status" do
-        @movie.status.should == "Flop"
-      end
-    end
-  
-    it "is sorted by decreasing rank" do
-      movie1 = Movie.new("goonies", 100)
-      movie2 = Movie.new("ghostbusters", 200)
-      movie3 = Movie.new("goldfinger", 300)
-    
-      movies = [movie1, movie2, movie3]
-    
-      movies.sort.should == [movie3, movie2, movie1]
-    end
-  
-    it "computes carbs consumed as the sum of all snack carbs consumed" do
-      @movie.carbs_consumed.should == 0
-
-      @movie.ate_snack(Snack.new(:popcorn, 10))
-
-      @movie.carbs_consumed.should == 10
-
-      @movie.ate_snack(Snack.new(:popcorn, 10))
-
-      @movie.carbs_consumed.should == 20
-
-      @movie.ate_snack(Snack.new(:soda, 5))
-    
-      @movie.carbs_consumed.should == 25
-    end
-  
-    it "yields each snack" do    
-      @movie.ate_snack(Snack.new(:popcorn, 10))
-      @movie.ate_snack(Snack.new(:popcorn, 10))
-      @movie.ate_snack(Snack.new(:soda, 5))
-    
-      yielded = []
-      @movie.each_snack do |snack|
-        yielded << snack
-      end
-    
-      yielded.should == [Snack.new(:popcorn, 20), Snack.new(:soda, 5)]
-    end
-  
-    it "can be instantiated from a CSV string" do
-      movie = Movie.from_csv("goonies,10")
-    
-      movie.title.should == "Goonies"
-      movie.rank.should == 10
-    end
-  
-    it "can be serialized to a CSV string" do  
-      movie = Movie.new("Goonies", 10)
-    
-      movie.to_csv.should == "Goonies,10" 
-    end
-  end
-end

data/spec/flicks/playlist_spec.rb

@@ -1,82 +0,0 @@
-require 'flicks/playlist'
-
-module Flicks
-  describe Playlist do
-    before do
-      @playlist = Playlist.new("Kermit")
-    end
-  
-    it "has a name" do
-      @playlist.name.should == "Kermit"
-    end
-  
-    context "being played with one movie" do
-      before do
-        @initial_rank = 10
-        @movie = Movie.new("Goonies", @initial_rank)
-      
-        @playlist.add_movie(@movie)
-      end
-  
-      it "gives the movie a thumbs up if a high number is rolled" do    
-        WaldorfAndStatler.stub(:roll_die).and_return(6)
-      
-        @playlist.play(2)
-    
-        @movie.rank.should == @initial_rank + 2
-
-        WaldorfAndStatler.stub(:roll_die).and_return(5)
-      
-        @playlist.play(2)
-    
-        @movie.rank.should == @initial_rank + 4
-      end
-    
-      it "skips the movie if a medium number is rolled" do
-        WaldorfAndStatler.stub(:roll_die).and_return(4)
-      
-        @playlist.play(2)
-    
-        @movie.rank.should == @initial_rank
-
-        WaldorfAndStatler.stub(:roll_die).and_return(3)
-      
-        @playlist.play(2)
-    
-        @movie.rank.should == @initial_rank
-      end
-    
-      it "gives the movie a thumbs down if a low number is rolled" do    
-        WaldorfAndStatler.stub(:roll_die).and_return(2)
-      
-        @playlist.play(2)
-    
-        @movie.rank.should == @initial_rank - 2
-
-        WaldorfAndStatler.stub(:roll_die).and_return(1)
-      
-        @playlist.play(2)
-    
-        @movie.rank.should == @initial_rank - 4
-      end
-    end
-
-    context "with movies that have caused snacks to be consumed" do
-      before do
-        movie1 = Movie.new("goonies")
-        movie2 = Movie.new("ghostbusters")
-
-        @playlist.add_movie(movie1)
-        @playlist.add_movie(movie2)
-
-        movie1.ate_snack(Snack.new(:popcorn, 10))
-        movie1.ate_snack(Snack.new(:popcorn, 10))
-        movie2.ate_snack(Snack.new(:soda, 5))
-      end
-    
-      it "computes total carbs consumed as the sum of all movie carbs consumed" do
-        @playlist.total_carbs_consumed.should == 25
-      end
-    end
-  end
-end

data/spec/flicks/snack_bar_spec.rb

@@ -1,32 +0,0 @@
-require 'flicks/snack_bar'
-
-module Flicks
-  describe Snack do
-    before do
-      @snack = Snack.new(:pretzel, 10)
-    end
-  
-    it "has a name attribute" do
-      @snack.name.should == :pretzel
-    end
-  
-    it "has a carbs attribute" do
-      @snack.carbs.should == 10
-    end
-  
-  end
-end
-
-module Flicks
-  describe SnackBar do
-    it "has a trove of treasures" do
-      SnackBar::SNACKS.should_not be_empty
-    end
-  
-    it "returns a random treasure" do
-      snack = SnackBar.random
-    
-      SnackBar::SNACKS.should include(snack)
-    end
-  end
-end