vagalume 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d06acfd5b52be5d23a930c642b0829efe4802ee2
-  data.tar.gz: e86a3b7e30b579405225cfc5f0a7c8be189abf52
+  metadata.gz: cdb570dd97273427b15f1f1038d14673f7e8220b
+  data.tar.gz: 4dd491d32fabed72de2253289668845f398babf0
 SHA512:
-  metadata.gz: 7ed49516aba72eab580b89eae5cb8ce508dfaee771088f063160e923dd8393c1ebb4f2797058588b8e3cd672dafc2b894fbe9bec242e4631b7abab4dc5d0595e
-  data.tar.gz: 89807c874b91ac1d6cdb4d8d69cfd32903ed2a8716647b6d730fba14c5349563c3d5aa460f04eb0960b40841221dfcbc86aa625213147ec587c29ee4763d4e2c
+  metadata.gz: 20fd8b6211abf6acb9ae361a00bcda7c990bc18cc1816c45e31cf4c64a78fb88516d022baa4f7b6c1ddfcc94306482e409d75894836b54adb8df1f77f3f370c5
+  data.tar.gz: 3ea8b96d1a530ff86efde1f8d4f2657da8306bc1b3912f6f10a2a15ca02f3495b6cd107208b9c93ac7218297a88eea0126d57e593e2eeb9c620731a6b06f40a5

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    vagalume (0.1.4)
-      multi_json (~> 1.9.2)
+    vagalume (0.1.6)
+      multi_json (~> 1.9)
 
 GEM
   remote: http://rubygems.org/
@@ -11,7 +11,7 @@ GEM
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
-    multi_json (1.9.3)
+    multi_json (1.10.1)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
@@ -31,7 +31,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.3)
-  rspec (~> 2.14.1)
+  rspec (~> 2.14)
   vagalume!
-  vcr (~> 2.9.0)
-  webmock (~> 1.17.4)
+  vcr (~> 2.9)
+  webmock (~> 1.17)

data/lib/vagalume.rb

@@ -16,12 +16,13 @@ module Vagalume
 
   def find(artist, song)
     request_url = BASE_URL + "art=#{CGI.escape(artist)}&mus=#{CGI.escape(song)}"
-    result_json = MultiJson.decode(open(request_url).read)
-    search_result = Vagalume::SearchResult.fetch(result_json)
+    result = MultiJson.decode(open(request_url).read)
+    search_result = Vagalume::SearchResult.new(result)
   end
 
   def get_lyric(artist, song, options)
     search = find(artist, song)
-    Vagalume::LyricFormatter.format(search, options)
+    formatter = Vagalume::LyricFormatter.new
+    formatter.format(search, options)
   end
 end

data/lib/vagalume/artist.rb

@@ -2,12 +2,10 @@ module Vagalume
   class Artist
     attr_accessor :id, :name, :url
 
-    def self.fetch(artist_json)
-      artist = Vagalume::Artist.new
-      artist.id = artist_json["id"]
-      artist.name = artist_json["name"] 
-      artist.url = artist_json["url"] 
-      artist
+    def initialize(artist)
+      @id = artist["id"]
+      @name = artist["name"]
+      @url = artist["url"]
     end
   end
 end

data/lib/vagalume/lyric_formatter.rb

@@ -1,40 +1,43 @@
-class Vagalume::LyricFormatter
-  class << self
+module Vagalume
+  class LyricFormatter
     def format(search, options)
-      status = search.status
-      song = search.song
-      translated_song = search.translations.with_language(Vagalume::Language::PORTUGUESE)
-      output = "\n\n"
+      return "No lyric found" if search.not_found?
 
-      return "No lyric found" if status == Vagalume::Status::NOT_FOUND || status == Vagalume::Status::SONG_NOT_FOUND
-      return "\n\n#{song.name}\n\n#{song.lyric}" unless options[:translation]
-      return "No translation found" if translated_song.nil?
+      original_song = search.song
 
-      bigger_line = bigger_line(song.lyric)
-      lyric_array = [song.name, ""]
-      translation_array = [translated_song.name, ""]
-
-      lyric_array += song.lyric.split("\n")
-      translation_array += translated_song.lyric.split("\n")
-
-      lyric_array.each_with_index do |lyric_line, index|
-        output += lyric_line + separator(bigger_line, lyric_line) + translation_array[index].to_s + "\n"
+      if options[:translation]
+        translated_song = search.translations.with_language(Vagalume::Language::PORTUGUESE)
+        return "No translation found" if translated_song.nil?
+        return formatted_song_with_transaction(original_song, translated_song)
       end
-      output
+
+      "\n\n#{original_song.name}\n\n#{original_song.lyric}"
     end
 
     private
 
-    def separator(bigger_line, lyric_line)
-      " " * (bigger_line - lyric_line.size) + "     |     "
-    end
+    def formatted_song_with_transaction(song, translated_song)
+      original_lyrics_lines = [song.name, ""] + song.lyric.split("\n")
+      translated_lyrics_lines = [translated_song.name, ""] + translated_song.lyric.split("\n")
+
+      biggest_line_size = biggest_line_size(song.lyric)
+      formatted_output = "\n\n"
 
-    def bigger_line(lyric)
-      bigger = 0
-      lyric.each_line do |line|
-        bigger = line.size if line.size > bigger
+      original_lyrics_lines.each_with_index do |original_line, index|
+        separator = find_separator(biggest_line_size, original_line)
+        translated_line = translated_lyrics_lines[index]
+        formatted_output += original_line + separator + translated_line.to_s + "\n"
       end
-      bigger
+
+      formatted_output
+    end
+
+    def find_separator(biggest_line_size, lyric_line)
+      " " * (biggest_line_size - lyric_line.size) + "     |     "
+    end
+
+    def biggest_line_size(lyric)
+      lyric.each_line.max { |a, b| a.length <=> b.length }.size
     end
   end
 end

data/lib/vagalume/search_result.rb

@@ -2,24 +2,25 @@ module Vagalume
   class SearchResult
     attr_accessor :status, :artist, :song, :translations
 
-    def initialize
+    def initialize(result)
       @translations = []
-    end
+      @status = result["type"]
+      return if not_found?
 
-    def self.fetch(result_json)
-      result = Vagalume::SearchResult.new
-      result.status = result_json["type"]
-      return result if result.status == Vagalume::Status::NOT_FOUND || result.status == Vagalume::Status::SONG_NOT_FOUND
-      song = result_json["mus"].first
-      artist = result_json["art"]
+      song = result["mus"].first
+      artist = result["art"]
       translations = song["translate"] || []
-      result.song = Vagalume::Song.fetch(song)
-      result.artist = Vagalume::Artist.fetch(artist)
+      @song = Vagalume::Song.new(song)
+      @artist = Vagalume::Artist.new(artist)
 
       translations.each do |translation|
-        result.translations << Vagalume::Song.fetch(translation)
+        @translations << Vagalume::Song.new(translation)
       end
-      result
+    end
+
+    def not_found?
+       @status == Vagalume::Status::NOT_FOUND ||
+       @status == Vagalume::Status::SONG_NOT_FOUND
     end
   end
 end

data/lib/vagalume/song.rb

@@ -2,18 +2,17 @@ module Vagalume
   class Song
     attr_accessor :id, :name, :language, :url, :lyric
 
-    def self.fetch(song_json)
-      song = Vagalume::Song.new
-      song.id = song_json["id"]
-      song.language = song_json["lang"]
-      song.url = song_json["url"]
-      song.lyric = song_json["text"]
-      song.name = song_json["name"]
-      if song.translation?
-        song.name = get_name_from_lyric(song.lyric)
-        song.lyric = remove_title(song.lyric)
+    def initialize(song)
+      @id = song["id"]
+      @language = song["lang"]
+      @url = song["url"]
+      @lyric = song["text"]
+      @name = song["name"]
+
+      if translation?
+        @name = get_name_from_lyric(@lyric)
+        @lyric = remove_title(@lyric)
       end
-      song
     end
 
     def translation?
@@ -22,20 +21,28 @@ module Vagalume
 
     private
 
-    def self.get_name_from_lyric(lyric)
+    def get_name_from_lyric(lyric)
       title = lyric.lines.first
       title.gsub(/\[|\]|\n/, "")
     end
 
-    # This is necessary because on translations, the song title comes with the
-    # lyric text, so we need to remove the first two lines, in order to
-    # have a consistent API with the song object
-    def self.remove_title(lyric)
-      lyric_lines_array = lyric.lines.to_a
-      lyric_lines_array.shift(2)
-      lyric = ""
-      lyric_lines_array.each { |line| lyric << line }
-      lyric
+    # This is necessary because, for translations, the song title comes with the
+    # lyric text. Also, the format is not always the same, sometimes it's just one line
+    # for the title, sometimes it's the title followed by some empty lines.
+    # Here we remove the first line and any following empty lines, so we have
+    # a consident API.
+    def remove_title(lyric)
+      lines = lyric.lines
+      lines.shift
+      lines = remove_empty_lines_from_beginning(lines)
+      lines.join
+    end
+
+    def remove_empty_lines_from_beginning(lines)
+      return lines unless lines.first.empty? || lines.first == "\n"
+
+      lines.shift
+      remove_empty_lines_from_beginning(lines)
     end
   end
 end

data/spec/array_spec.rb

@@ -3,7 +3,7 @@
 require "spec_helper"
 
 describe Array do
-  it "return song with selected language" do
+  it "returns song with selected language" do
     right_song = double "Song"
     right_song.stub(:language).and_return(Vagalume::Language::PORTUGUESE)
 

data/spec/base_spec.rb

@@ -4,52 +4,48 @@ require "spec_helper"
 
 describe Vagalume do
 
-  before(:each) do
+  before do
     VCR.use_cassette('vagalume') do
       @result = Vagalume.find("Metallica", "The Unforgiven")
     end
   end
 
-  it "should bring song" do
-    song = @result.song
-    artist = @result.artist
-    lyric = File.read 'spec/assets/unforgiven_lyric.txt'
-
+  it "returns parsed result" do
     @result.status.should == Vagalume::Status::EXACT
 
-    song.id.should == "3ade68b6g470deda3"
-    song.name.should == "The Unforgiven"
-    song.language.should == Vagalume::Language::ENGLISH
-    song.url.should == "http://www.vagalume.com.br/metallica/the-unforgiven.html"
-    song.lyric.should == lyric.chop!
+    @result.song.id.should == "3ade68b6g470deda3"
+    @result.song.name.should == "The Unforgiven"
+    @result.song.language.should == Vagalume::Language::ENGLISH
+    @result.song.url.should == "http://www.vagalume.com.br/metallica/the-unforgiven.html"
+    @result.song.lyric.should == File.read('spec/assets/unforgiven_lyric.txt').chop
 
-    artist.id.should == "3ade68b5g7257eda3"
-    artist.name.should == "Metallica"
-    artist.url.should == "http://www.vagalume.com.br/metallica/"
+    @result.artist.id.should == "3ade68b5g7257eda3"
+    @result.artist.name.should == "Metallica"
+    @result.artist.url.should == "http://www.vagalume.com.br/metallica/"
   end
 
-  it "should return result with song not found status" do
+  it "returns result with song not found status" do
     VCR.use_cassette('vagalume_song_not_found') do
       result = Vagalume.find("Metallica", "Oops")
       result.status.should == Vagalume::Status::SONG_NOT_FOUND
     end
   end
 
-  it "should return result with not found status" do
+  it "returns result with not found status" do
     VCR.use_cassette('vagalume_not_found') do
       result = Vagalume.find("Oops", "Oops")
       result.status.should == Vagalume::Status::NOT_FOUND
     end
   end
 
-  it "should have translations" do
+  it "has translations" do
     @result.translations.should_not be_empty
     pt_translation = @result.translations.with_language(Vagalume::Language::PORTUGUESE)
     lyric = File.read 'spec/assets/unforgiven_lyric_translation_pt.txt'
     pt_translation.lyric.should == lyric.chop!
   end
 
-  it "should get right song name for translations" do
+  it "gets the right song name for translations" do
     translated_song = @result.translations.with_language(Vagalume::Language::PORTUGUESE)
     translated_song.name.should == "Os Imperdoáveis"
   end

data/spec/lyric_formatter_spec.rb

@@ -4,33 +4,33 @@ require "spec_helper"
 
 describe Vagalume::LyricFormatter do
   context "there is a translation available" do
-    before(:each) do
+    before do
       VCR.use_cassette('vagalume') do
         @search = Vagalume.find("Metallica", "The Unforgiven")
       end
     end
 
-    it "should format song without translation option" do
+    it "formats song without translation option" do
       options = {:translation => false}
-      formatted_lyric = Vagalume::LyricFormatter.format(@search, options)
+      formatted_lyric = subject.format(@search, options)
       lyric = File.read 'spec/assets/lyric_formatter/unforgiven_lyric.txt'
       formatted_lyric.should == lyric
     end
 
-    it "should format song with translation" do
+    it "formats song with translation" do
       options = {:translation => true}
-      formatted_lyric = Vagalume::LyricFormatter.format(@search, options)
+      formatted_lyric = subject.format(@search, options)
       lyric = File.read 'spec/assets/lyric_formatter/unforgiven_lyric_with_translation.txt'
       formatted_lyric.should == lyric
     end
   end
 
   context "there is no translation available" do
-    it "should inform user there is no translation available" do
+    it "informs that there is no translation available" do
       VCR.use_cassette('vagalume_with_no_translation_available') do
         @search = Vagalume.find("Bruce Springsteen", "Ain't good enough for You")
         options = {:translation => true}
-        output = Vagalume::LyricFormatter.format(@search, options)
+        output = subject.format(@search, options)
         output.should == "No translation found"
       end
     end

data/spec/search_result_spec.rb

@@ -0,0 +1,17 @@
+#encoding: utf-8
+
+require "spec_helper"
+
+describe Vagalume::SearchResult do
+  it 'knows the song was not found when the status is NOT_FOUND' do
+    result = { "type" => Vagalume::Status::NOT_FOUND }
+    search_result = Vagalume::SearchResult.new(result)
+    search_result.not_found?.should be_true
+  end
+
+  it 'knows the song was not found when the status is SONG_NOT_FOUND' do
+    result = { "type" => Vagalume::Status::SONG_NOT_FOUND }
+    search_result = Vagalume::SearchResult.new(result)
+    search_result.not_found?.should be_true
+  end
+end

data/spec/song_spec.rb

@@ -0,0 +1,24 @@
+#encoding: utf-8
+
+require "spec_helper"
+
+describe Vagalume::Song do
+  let(:translation_lyric) do
+    "title
+
+
+    Lyric"
+  end
+
+  it "removes the title from the lyrics for translations" do
+    params = { "name" => nil, "text" => translation_lyric }
+    song = Vagalume::Song.new(params)
+    song.lyric.strip.should == "Lyric"
+  end
+
+  it "doesn't change the lyrics when it's not a translation" do
+    params = { "name" => "Foo", "text" => translation_lyric }
+    song = Vagalume::Song.new(params)
+    song.lyric.should == translation_lyric
+  end
+end

data/vagalume.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 Gem::Specification.new do |spec|
   spec.name          = "vagalume"
   spec.executables   = ["vagalume"]
-  spec.version       = "0.1.5"
+  spec.version       = "0.1.6"
   spec.authors       = ["Brian Thomas Storti"]
   spec.email         = ["btstorti@gmail.com"]
   spec.description   = "Ruby interface for the Vagalume API"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagalume
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Brian Thomas Storti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-28 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -115,6 +115,8 @@ files:
 - spec/fixtures/vcr_cassettes/vagalume_song_not_found.yml
 - spec/fixtures/vcr_cassettes/vagalume_with_no_translation_available.yml
 - spec/lyric_formatter_spec.rb
+- spec/search_result_spec.rb
+- spec/song_spec.rb
 - spec/spec_helper.rb
 - vagalume.gemspec
 - vagalume.jpg