pincerna 1.1.3

data/spec/cassettes/Pincerna_Weather/_perform_filtering/should_get_forecast.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://where.yahooapis.com/v1/places.q(QUERY);count=5?appid=dj0yJmk9ZUpBZk1hQTJGRHM5JmQ9WVdrOVlUSnBjMGhUTjJVbWNHbzlOemsyTURNeU5EWXkmcz1jb25zdW1lcnNlY3JldCZ4PWRi&format=json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - '*'
+      Cache-Control:
+      - public, must-revalidate
+      Connection:
+      - Keep-Alive
+      Content-Encoding:
+      - gzip
+      Content-Language:
+      - en-US
+      Content-Type:
+      - application/json; charset=UTF-8
+      Date:
+      - Wed, 07 Aug 2013 16:16:16 GMT
+      P3p:
+      - policyref="http://info.yahoo.com/w3c/p3p.xml", CP="CAO DSP COR CUR ADM DEV
+        TAI PSA PSD IVAi IVDi CONi TELo OTPi OUR DELi SAMi OTRi UNRi PUBi IND PHY
+        ONL UNI PUR FIN COM NAV INT DEM CNT STA POL HEA PRE LOC GOV"
+      Server:
+      - HTTP/1.1 UserFiberFramework/1.0
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      Via:
+      - HTTP/1.1 r08.ycpi.gq1.yahoo.net UserFiberFramework/1.0
+      X-Yahoo-Serving-Host:
+      - wws3.geotech.gq1.yahoo.com
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA6pWKshJTE4tVrKqViouSSwqUbIy0FFKzi/Ng7BK8ksSc4Cs
+        2loAAAAA//8DAACYu9cqAAAA
+    http_version: 
+  recorded_at: Wed, 07 Aug 2013 16:16:16 GMT
+recorded_with: VCR 2.5.0

data/spec/coverage_helper.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+#
+# This file is part of the pincerna gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
+#
+
+require "pathname"
+require "simplecov"
+require "coveralls"
+require "json"
+
+Coveralls.wear! if ENV["CI"] || ENV["JENKINS_URL"] # Do not load outside Travis
+
+SimpleCov.start do
+  root = Pathname.new(File.dirname(__FILE__)) + ".."
+
+  add_filter do |src_file|
+    path = Pathname.new(src_file.filename).relative_path_from(root).to_s
+    path !~ /^lib/
+  end
+end
+
+# Backport this to fix an issue with ruby-units (https://github.com/colszowka/simplecov/pull/175).
+# Remove once Simplecov reaches v-0.8.0.
+class SimpleCov::FileList < Array
+  def covered_strength
+    return 0 if empty? or lines_of_code == 0
+    map {|f| f.covered_strength }.reduce(&:+).to_f / size
+  end
+end
+
+class SimpleCov::SourceFile
+  def covered_percent
+    return 100.0 if lines.length == 0 or lines.length == never_lines.count
+    relevant_lines = lines.count - never_lines.count - skipped_lines.count
+    if relevant_lines == 0
+      0
+    else
+      (covered_lines.count) * 100.0 / relevant_lines.to_f
+    end
+  end
+end
+
+

data/spec/pincerna/base_spec.rb

@@ -0,0 +1,166 @@
+# encoding: utf-8
+#
+# This file is part of the pincerna gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
+#
+
+require "spec_helper"
+require "yaml"
+
+describe Pincerna::Base do
+  subject { Pincerna::Base.new("QUERY", "yml") }
+
+  let(:reference_xml) {
+    <<EOXML
+<?xml version="1.0"?>
+<items>
+  <item first="FIRST" second="SECOND" third="THIRD">
+    <title>TITLE 1</title>
+    <subtitle>SUBTITLE 1</subtitle>
+    <icon>ICON 1</icon>
+  </item>
+  <item fourth="FOURTH" fifth="FIFTH" sixth="SIXTH">
+    <title>TITLE 2</title>
+    <subtitle>SUBTITLE 2</subtitle>
+    <icon>ICON 2</icon>
+  </item>
+</items>
+EOXML
+
+  }
+  describe ".execute" do
+    it "should find relevant class" do
+      expect(Pincerna::Map).to receive(:new).and_call_original
+      expect(Pincerna::Base.execute!("map", "QUERY"))
+    end
+
+    it "should create a query and then filter" do
+      query = ::Object.new
+      expect(query).to receive(:filter).and_return("FILTER")
+      expect(Pincerna::Map).to receive(:new).with("QUERY", "FORMAT", "DEBUG").and_return(query)
+      expect(Pincerna::Base.execute!("map", "QUERY", "FORMAT", "DEBUG"))
+    end
+
+    it "should not fail if a matching class is not found" do
+      expect { expect(Pincerna::Base.execute!("invalid", "QUERY")) }.not_to raise_error
+    end
+  end
+
+  describe "#initalize" do
+    it "should initialize correct attributes" do
+      expect(subject.instance_variable_get(:@query)).to eq("QUERY")
+      expect(subject.instance_variable_get(:@cache_dir)).to eq(::File.expand_path("~/Library/Caches/com.runningwithcrayons.Alfred-2/Workflow Data/it.cowtech.pincerna"))
+      expect(subject.instance_variable_get(:@feedback_items)).to eq([])
+      expect(subject.format).to eq(:yml)
+
+    end
+
+    it "should save debug mode" do
+      reference = Pincerna::Base.new("QUERY", "yml", "DEBUG")
+      expect(reference.instance_variable_get(:@debug)).to eq("DEBUG")
+    end
+
+    it "should save format" do
+      reference = Pincerna::Base.new("QUERY", "yml", "DEBUG")
+      expect(reference.format).to eq(:yml)
+      expect(reference.format_content_type).to eq("text/x-yaml")
+
+      reference = Pincerna::Base.new("QUERY", "yaml", "DEBUG")
+      expect(reference.format).to eq(:yml)
+      expect(reference.format_content_type).to eq("text/x-yaml")
+
+      reference = Pincerna::Base.new("QUERY", "FOO", "DEBUG")
+      expect(reference.format).to eq(:xml)
+      expect(reference.format_content_type).to eq("text/xml")
+    end
+  end
+
+  describe "#filter" do
+    before(:each) do
+      allow(subject).to receive(:perform_filtering).with("QUERY").and_return([{query: "query"}])
+      allow(subject).to receive(:process_results).with([{query: "query"}]).and_return([{title: "QUERY", arg: "query"}])
+    end
+
+    it "match the query, filter it and then process" do
+      expect(subject.filter).to eq_as_yaml([{title: "QUERY", arg: "query"}])
+    end
+
+    it "should return an array if a failure occurs" do
+      allow(subject).to receive(:perform_filtering).and_raise(::ArgumentError)
+      allow(subject).to receive(:process_results).with([]).and_return([])
+      expect(subject.filter).to eq_as_yaml([])
+    end
+  end
+
+  describe "#perform_filtering" do
+    it "should abort with a warning" do
+      expect { subject.perform_filtering([]) }.to raise_error(::ArgumentError)
+    end
+  end
+
+  describe "#process_results" do
+    it "should abort with a warning" do
+      expect { subject.process_results([]) }.to raise_error(::ArgumentError)
+    end
+  end
+
+  describe "#add_feedback_item" do
+    before(:each) do
+      subject.add_feedback_item("ITEM 1")
+      subject.add_feedback_item("ITEM 2")
+    end
+
+    it "should append to the internal items list" do
+      expect(subject.instance_variable_get(:@feedback_items)).to eq(["ITEM 1", "ITEM 2"])
+    end
+  end
+
+  describe "#output_feedback" do
+    describe "when not in debug" do
+      before(:each) do
+        subject.add_feedback_item({title: "TITLE 1", subtitle: "SUBTITLE 1", icon: "ICON 1", first: "FIRST", second: "SECOND", third: "THIRD"})
+        subject.add_feedback_item({title: "TITLE 2", subtitle: "SUBTITLE 2", icon: "ICON 2", fourth: "FOURTH", fifth: "FIFTH", sixth: "SIXTH"})
+        allow(subject).to receive(:format).and_return(:xml)
+        allow(subject).to receive(:debug_mode).and_return(nil)
+      end
+
+      it "should return items as XML" do
+        expect(subject.output_feedback.gsub(/\s/, "")).to eq(reference_xml.gsub(/\s/, ""))
+      end
+    end
+
+    describe "when in debug" do
+      before(:each) do
+        subject.add_feedback_item("ITEM 1")
+        subject.add_feedback_item("ITEM 2")
+      end
+
+      it "should return items as YAML" do
+        expect(subject.output_feedback).to eq_as_yaml(["ITEM 1", "ITEM 2"])
+      end
+    end
+  end
+
+  describe "#round_float" do
+    it "should round a float to a certain precision" do
+      expect(subject.round_float(1)).to eq(1.000)
+      expect(subject.round_float(123.4567)).to eq(123.457)
+      expect(subject.round_float(123.456781, 5)).to eq(123.45678)
+    end
+  end
+
+  describe "#format_float" do
+    it "should format a float to a certain precision" do
+      expect(subject.format_float(1)).to eq("1")
+      expect(subject.format_float(123.45, 5)).to eq("123.45")
+      expect(subject.format_float(123.4567)).to eq("123.457")
+      expect(subject.format_float(123.456781, 5)).to eq("123.45678")
+    end
+  end
+
+  describe "#execute_command" do
+    it "should return the output of a command" do
+      expect(subject.send(:execute_command, "date", "+%s")).to match(/\d+/)
+    end
+  end
+end

data/spec/pincerna/bookmark_spec.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+#
+# This file is part of the pincerna gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
+#
+
+require "spec_helper"
+
+describe Pincerna::Bookmark do
+  subject { Pincerna::Bookmark.new("QUERY", "yml") }
+
+  describe "#perform_filtering" do
+    before(:each) do
+      cache = Object.new
+      allow(cache).to receive(:use).and_yield
+      allow(Pincerna::Cache).to receive(:instance).and_return(cache)
+
+      allow(subject).to receive(:read_bookmarks) {
+        subject.instance_variable_set(:@bookmarks, [
+          {name: "NAME 1", url: "URL 1", path: " \u2192 Barra dei Preferiti \u2192 FOLDER 1 \u2192 FOLDER 2"},
+          {name: "2", url: "2", path: " \u2192 Barra dei Preferiti \u2192 FOLDER 1 \u2192 FOLDER 2"},
+          {name: "NAME 3", url: "URL 3", path: " \u2192 Barra dei Preferiti \u2192 FOLDER 1"},
+          {name: "NAME 3", url: "URL 3", path: " \u2192 Altri Preferiti"}
+        ])
+      }
+    end
+
+    it "should call #read_bookmarks" do
+      expect(subject).to receive(:read_bookmarks)
+      subject.perform_filtering("1")
+    end
+
+    it "should filter by query and sort correctly" do
+      expect(subject.perform_filtering("")).to eq([
+        {name: "2", url: "2", path: " \u2192 Barra dei Preferiti \u2192 FOLDER 1 \u2192 FOLDER 2"},
+        {name: "NAME 1", url: "URL 1", path: " \u2192 Barra dei Preferiti \u2192 FOLDER 1 \u2192 FOLDER 2"},
+        {name: "NAME 3", url: "URL 3", path: " \u2192 Altri Preferiti"},
+        {name: "NAME 3", url: "URL 3", path: " \u2192 Barra dei Preferiti \u2192 FOLDER 1"}
+      ])
+
+      expect(subject.perform_filtering("NAME")).to eq([
+        {name: "NAME 1", url: "URL 1", path: " \u2192 Barra dei Preferiti \u2192 FOLDER 1 \u2192 FOLDER 2"},
+        {name: "NAME 3", url: "URL 3", path: " \u2192 Altri Preferiti"},
+        {name: "NAME 3", url: "URL 3", path: " \u2192 Barra dei Preferiti \u2192 FOLDER 1"}
+      ])
+
+      expect(subject.perform_filtering("2")).to eq([{name: "2", url: "2", path: " \u2192 Barra dei Preferiti \u2192 FOLDER 1 \u2192 FOLDER 2"}])
+
+      expect(subject.perform_filtering("3")).to eq([])
+    end
+  end
+
+  describe "#read_bookmarks" do
+    it "should abort with a warning" do
+      expect { subject.read_bookmarks }.to raise_error(::ArgumentError)
+    end
+  end
+
+  describe "#process_results" do
+    it "should correctly prepare results" do
+      expect(subject.process_results([{name: "TITLE", url: "URL"}])).to eq([{title: "TITLE", arg: "URL", subtitle: "Action this item to open the URL in the browser ...", icon: Pincerna::Bookmark::ICON}])
+      expect(subject.process_results([{name: "TITLE", url: "URL", path: "PATH"}])).to eq([{title: "TITLE", arg: "URL", subtitle: "PATH", icon: Pincerna::Bookmark::ICON}])
+    end
+  end
+end

data/spec/pincerna/cache_spec.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+#
+# This file is part of the pincerna gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
+#
+
+require "spec_helper"
+
+describe Pincerna::Cache do
+  before(:each) do
+    Pincerna::Cache.instance_variable_set(:@instance, nil)
+    stub_const("Pincerna::Cache::FILE", "/tmp/pincerna-cache.db")
+    allow_any_instance_of(EventMachine::PeriodicTimer).to receive(:schedule)
+  end
+
+  after(:each) do
+    Pincerna::Cache.instance.destroy
+    FileUtils.rm_f(Pincerna::Cache::FILE)
+  end
+
+  describe ".instance" do
+    it "should return the instance" do
+      expect(Pincerna::Cache).to receive(:new).once.and_call_original
+      instance = Pincerna::Cache.instance
+      expect(instance).to be_a(Pincerna::Cache)
+      expect(instance).to be(Pincerna::Cache.instance)
+    end
+  end
+
+  describe "#initialize" do
+    it "should initialize variables" do
+      expect(Pincerna::Cache.instance.instance_variable_get(:@flusher)).to be_a(EventMachine::PeriodicTimer)
+      expect(Pincerna::Cache.instance.instance_variable_get(:@data)).to be_a(Daybreak::DB)
+    end
+  end
+
+  describe "#use" do
+    before(:each) do
+      allow(Time).to receive(:now).and_return(1000)
+      @control = ""
+    end
+
+    it "should read data from the store and not call the block, if present" do
+      Pincerna::Cache.instance.data["KEY"] = {expiration: Time.now.to_f + 1800, data: "1"}
+      expect(Pincerna::Cache.instance.use("KEY", 1800) { @control = "2" }).to eq("1")
+      expect(@control).to eq("")
+    end
+
+    it "should fetch new data if nothing is in cache, then save it back" do
+      Pincerna::Cache.instance.data["KEY"] = nil
+      expect(Pincerna::Cache.instance.use("KEY", 1800) { @control = "2" }).to eq("2")
+      expect(Pincerna::Cache.instance.data["KEY"]).to eq({data: "2", expiration: 2800})
+      expect(@control).to eq("2")
+    end
+
+    it "should fetch new data if the old one expired" do
+      Pincerna::Cache.instance.data["KEY"] = {expiration: 800, data: "1"}
+      expect(Pincerna::Cache.instance.use("KEY", 1800) { @control = "2" }).to eq("2")
+      expect(Pincerna::Cache.instance.data["KEY"]).to eq({data: "2", expiration: 2800})
+      expect(@control).to eq("2")
+    end
+  end
+
+  describe "#destroy" do
+    before(:each) do
+      flusher = Pincerna::Cache.instance.instance_variable_get(:@flusher)
+      data = Pincerna::Cache.instance.instance_variable_get(:@data)
+      expect(flusher).to receive(:cancel).twice
+      expect(data).to receive(:close).twice.and_call_original
+    end
+
+    it "should cancel the flusher and close the data" do
+      Pincerna::Cache.instance.destroy
+    end
+  end
+
+  describe "#flush" do
+    before(:each) do
+      data = Pincerna::Cache.instance.instance_variable_get(:@data)
+      expect(data).to receive(:flush)
+      expect(data).to receive(:compact)
+    end
+
+    it "should flush and compact data" do
+      Pincerna::Cache.instance.flush
+    end
+  end
+end

data/spec/pincerna/chrome_bookmark_spec.rb

@@ -0,0 +1,114 @@
+# encoding: utf-8
+#
+# This file is part of the pincerna gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
+#
+
+require "spec_helper"
+
+describe Pincerna::ChromeBookmark do
+  subject { Pincerna::ChromeBookmark.new("QUERY", "yml") }
+
+  describe "#Chrome_bookmarks" do
+    before(:each) do
+      @json = <<EOJSON
+{
+  "checksum": "",
+  "roots": {
+    "bookmark_bar": {
+      "children": [
+        {
+          "children": [
+            {
+              "children": [
+                {
+                  "date_added": "13018920348983801",
+                  "id": "1145",
+                  "name": "NAME 1",
+                  "type": "url",
+                  "url": "URL 1"
+                },
+                {
+                  "date_added": "13018920348983801",
+                  "id": "1145",
+                  "name": "NAME 2",
+                  "type": "url",
+                  "url": "URL 2"
+                }
+              ],
+              "date_added": "13018920348874387",
+              "date_modified": "13018920348996854",
+              "id": "1087",
+              "name": "FOLDER 2",
+              "type": "folder"
+            },
+            {
+              "date_added": "13018920348983801",
+              "id": "1145",
+              "name": "NAME 3",
+              "type": "url",
+              "url": "URL 3"
+            }
+          ],
+          "date_added": "13018920348873174",
+          "date_modified": "13018920348989347",
+          "id": "1086",
+          "name": "FOLDER 1",
+          "type": "folder"
+        }
+      ],
+      "date_added": "12980910274469592",
+      "date_modified": "13005935882687426",
+      "id": "1",
+      "name": "Barra dei Preferiti",
+      "type": "folder"
+    },
+    "other": {
+      "children": [
+        {
+          "date_added": "13018920348983801",
+          "id": "1145",
+          "name": "NAME 4",
+          "type": "url",
+          "url": "URL 4"
+        }
+      ],
+      "date_added": "12980910274469613",
+      "date_modified": "13020577556062605",
+      "id": "2",
+      "name": "Altri Preferiti",
+      "type": "folder"
+    },
+    "synced": {
+      "children": [  ],
+      "date_added": "12980910274469615",
+      "date_modified": "0",
+      "id": "3",
+      "name": "Preferiti su disp. mobili",
+      "type": "folder"
+    }
+  },
+  "version": 1
+}
+EOJSON
+    end
+
+    it "should read the JSON file to get latest bookmarks" do
+      expect(File).to receive(:read).with(File.expand_path("~/Library/Application Support/Google/Chrome/Default/Bookmarks")).and_return("{}")
+      expect(Oj).to receive(:load).with("{}").and_return({"roots" => {}})
+      subject.read_bookmarks
+    end
+
+    it "should return the correct list of bookmarks" do
+      expect(subject.instance_variable_set(:@bookmarks, []))
+      expect(File).to receive(:read).and_return(@json)
+      subject.read_bookmarks
+      expect(subject.instance_variable_get(:@bookmarks)).to eq([
+        {name: "NAME 1", url: "URL 1", path: " \u2192 Barra dei Preferiti \u2192 FOLDER 1 \u2192 FOLDER 2"},
+        {name: "NAME 2", url: "URL 2", path: " \u2192 Barra dei Preferiti \u2192 FOLDER 1 \u2192 FOLDER 2"},
+        {name: "NAME 3", url: "URL 3", path: " \u2192 Barra dei Preferiti \u2192 FOLDER 1"},
+        {name: "NAME 4", url: "URL 4", path: " \u2192 Altri Preferiti"}
+      ])
+    end
+  end
+end