inqlude 0.7.0 → 0.7.1

data/spec/data/karchive-release-5.4.manifest

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://inqlude.org/schema/release-manifest-v1#",
+  "name": "karchive",
+  "display_name": "KArchive",
+  "release_date": "2014-11-06",
+  "version": "5.4.0",
+  "summary": "Reading, creating, and manipulating file archives",
+  "urls": {
+    "homepage": "https://projects.kde.org/projects/frameworks/karchive",
+    "download": "http://download.kde.org/stable/frameworks/5.4/",
+    "vcs": "https://projects.kde.org/projects/frameworks/karchive/repository",
+    "mailing_list": "https://mail.kde.org/mailman/listinfo/kde-frameworks-devel"
+  },
+  "licenses": [
+    "LGPLv2.1+"
+  ],
+  "description": "KArchive provides classes for easy reading, creation and manipulation of\n\"archive\" formats like ZIP and TAR.\n\nIf also provides transparent compression and decompression of data, like the\nGZip format, via a subclass of QIODevice.",
+  "authors": [
+    "The KDE Community"
+  ],
+  "maturity": "stable",
+  "platforms": [
+    "Linux"
+  ],
+  "packages": {
+    "source": "http://download.kde.org/stable/frameworks/5.4/karchive-5.4.0.tar.xz"
+  },
+  "group": "kde-frameworks"
+}

data/spec/data/karchive-release.manifest

@@ -2,12 +2,14 @@
   "$schema": "http://inqlude.org/schema/release-manifest-v1#",
   "name": "karchive",
   "display_name": "KArchive",
+  "release_date": "2014-07-07",
+  "version": "5.0.0",
   "summary": "Reading, creating, and manipulating file archives",
   "urls": {
     "homepage": "https://projects.kde.org/projects/frameworks/karchive",
+    "download": "http://download.kde.org/stable/frameworks/5.0.0/",
     "vcs": "https://projects.kde.org/projects/frameworks/karchive/repository",
-    "mailing_list": "https://mail.kde.org/mailman/listinfo/kde-frameworks-devel",
-    "download": "http://download.kde.org/stable/frameworks/5.0.0/"
+    "mailing_list": "https://mail.kde.org/mailman/listinfo/kde-frameworks-devel"
   },
   "licenses": [
     "LGPLv2.1+"
@@ -16,14 +18,12 @@
   "authors": [
     "The KDE Community"
   ],
+  "maturity": "stable",
   "platforms": [
     "Linux"
   ],
-  "group": "kde-frameworks",
-  "maturity": "stable",
-  "release_date": "2014-07-07",
-  "version": "5.0.0",
   "packages": {
     "source": "http://download.kde.org/stable/frameworks/5.0.0/karchive-5.0.0.tar.xz"
-  }
+  },
+  "group": "kde-frameworks"
 }

data/spec/data/karchive.readme

@@ -27,9 +27,3 @@ appropriate subclass of KArchive (eg: K7Zip for 7-Zip files).  You may need to
 combine this with usage of KCompressionDevice (see the API documentation for the
 relevant KArchive subclass for details).
 
-## Links
-
-- Home page: <https://projects.kde.org/projects/frameworks/karchive>
-- Mailing list: <https://mail.kde.org/mailman/listinfo/kde-frameworks-devel>
-- IRC channel: #kde-devel on Freenode
-- Git repository: <https://projects.kde.org/projects/frameworks/karchive/repository>

data/spec/data/newlib/newlib.manifest

@@ -6,8 +6,15 @@
     "homepage": "http://new.example.org",
     "download": "http://new.example.org/download"
   },
-  "licenses": ["GPLv3"],
+  "licenses": [
+    "GPLv3"
+  ],
   "description": "This is an awesome library. It's new.",
-  "authors": ["Cornelius Schumacher <schumacher@kde.org>"],
-  "platforms": [ "Linux", "Windows" ]
-}
+  "authors": [
+    "Cornelius Schumacher <schumacher@kde.org>"
+  ],
+  "platforms": [
+    "Linux",
+    "Windows"
+  ]
+}

data/spec/data/rendertest-generic.manifest

@@ -5,7 +5,10 @@
   "summary": "Test manifest for testing rendering",
   "urls": {
     "homepage": "https://example.org",
-    "vcs": "https://example.org/git"
+    "vcs": "https://example.org/git",
+    "custom": {
+      "Special": "http://special.example.org"
+    }
   },
   "licenses": [
     "LGPLv2.1+"

data/spec/integration/cli_create_spec.rb

@@ -0,0 +1,24 @@
+require_relative "spec_helper"
+
+include CliTester
+
+describe "Command line interface" do
+  include GivenFilesystemSpecHelpers
+
+  use_given_filesystem
+
+  describe "create" do
+    it "creates new manifest" do
+
+      dir = given_directory
+
+      result = run_command(args: ["create", "--offline",
+        "--manifest_dir=#{dir}", "newlib", "42.1", "2015-06-13"],
+        working_directory: dir)
+      expect(result).to exit_with_success("")
+
+      expect(File.exist?(File.join(dir, "newlib", "newlib.2015-06-13.manifest"))).
+        to be(true)
+    end
+  end
+end

data/spec/integration/cli_general_spec.rb

@@ -0,0 +1,19 @@
+require_relative "spec_helper"
+
+include CliTester
+
+describe "Command line interface" do
+  describe "shows error" do
+    it "when command does not exist" do
+      expect(run_command(args: ["abc"])).to exit_with_success("", /abc/)
+    end
+
+    it "when global option does not exist" do
+      expect(run_command(args: ["--abc"])).to exit_with_success("", /--abc/)
+    end
+
+    it "when command option does not exist" do
+      expect(run_command(args: ["list", "--abc"])).to exit_with_success("", /--abc/)
+    end
+  end
+end

data/spec/integration/cli_get_involved_spec.rb

@@ -0,0 +1,14 @@
+require_relative "spec_helper"
+
+include CliTester
+
+describe "Command line interface" do
+  describe "get_involved" do
+    it "shows list of open issues" do
+      result = run_command(args: ["get_involved"])
+      expect(result.exit_code).to eq(0)
+      expect(result.stdout).to match("github.com/cornelius/inqlude/issues")
+      expect(result.stderr.empty?).to be(true)
+    end
+  end
+end

data/spec/integration/cli_help_spec.rb

@@ -0,0 +1,21 @@
+require_relative "spec_helper"
+
+include CliTester
+
+describe "Command line interface" do
+  describe "help" do
+    it "shows general help" do
+      result = run_command
+      expect(result.exit_code).to eq(0)
+      expect(result.stdout).to match(/Commands:/)
+      expect(result.stderr.empty?).to be(true)
+    end
+
+    it "shows help for command" do
+      result = run_command(args: ["help", "list"])
+      expect(result.exit_code).to eq(0)
+      expect(result.stdout).to match("inqlude list")
+      expect(result.stderr.empty?).to be(true)
+    end
+  end
+end

data/spec/integration/cli_list_spec.rb

@@ -0,0 +1,23 @@
+require_relative "spec_helper"
+
+include CliTester
+
+describe "Command line interface" do
+  include GivenFilesystemSpecHelpers
+
+  use_given_filesystem
+
+  describe "list" do
+    it "lists libraries" do
+
+      dir = given_directory do
+        given_directory_from_data("awesomelib")
+        given_directory_from_data("newlib")
+      end
+
+      result = run_command(args: ["list", "--remote", "--offline",
+        "--manifest_dir=#{dir}"])
+      expect(result).to exit_with_success("awesomelib (0.2.0)\nnewlib ()\n")
+    end
+  end
+end

data/spec/integration/cli_verify_spec.rb

@@ -0,0 +1,37 @@
+require_relative "spec_helper"
+
+include CliTester
+
+describe "Command line interface" do
+  include GivenFilesystemSpecHelpers
+
+  use_given_filesystem(keep_files: true)
+
+  describe "verify" do
+    it "verifies single manifest" do
+      dir = given_directory do
+        given_directory_from_data("awesomelib")
+      end
+
+      result = run_command(args: ["verify",
+        File.join(dir, "awesomelib", "awesomelib.2013-09-08.manifest")])
+      expect(result).to exit_with_success("Verify manifest awesomelib.2013-09-08.manifest...ok\n")
+    end
+
+    it "verifies all manifests" do
+      dir = given_directory do
+        given_directory_from_data("awesomelib")
+        given_directory_from_data("newlib")
+      end
+
+      result = run_command(args: ["verify", "--offline", "--manifest_dir=#{dir}"])
+      expected_output = <<EOT
+Verify manifest awesomelib.2013-09-08.manifest...ok
+Verify manifest newlib.manifest...ok
+
+2 manifests checked. 2 ok, 0 with error.
+EOT
+      expect(result).to exit_with_success(expected_output)
+    end
+  end
+end

data/spec/integration/cli_view_spec.rb

@@ -0,0 +1,28 @@
+require_relative "spec_helper"
+
+include CliTester
+
+describe "Command line interface" do
+  include GivenFilesystemSpecHelpers
+
+  use_given_filesystem
+
+  describe "view" do
+    it "generates view" do
+      dir = given_directory do
+        given_directory_from_data("awesomelib")
+        given_directory_from_data("newlib")
+      end
+
+      output_dir = given_directory
+
+      result = run_command(args: ["view", "--offline",
+        "--manifest_dir=#{dir}", "--output-dir=#{output_dir}"])
+      expect(result).to exit_with_success(/Creating web site/)
+
+      expect(File.exist?(File.join(output_dir, "index.html"))).to be(true)
+      expect(File.exist?(File.join(output_dir, "libraries", "awesomelib.html"))).to be(true)
+      expect(File.exist?(File.join(output_dir, "libraries", "newlib.html"))).to be(true)
+    end
+  end
+end

data/spec/integration/spec_helper.rb

@@ -0,0 +1,2 @@
+require "cli_tester"
+require "given_filesystem/spec_helpers"

data/spec/{creator_spec.rb → unit/creator_spec.rb}

@@ -44,28 +44,12 @@ describe Creator do
 
     expect(mh.libraries.count).to eq 1
     m = mh.manifest "awesomelib"
-    expect(m["name"]).to eq "awesomelib"
-    expect(m["version"]).to eq "1.0"
-    expect(m["release_date"]).to eq "2013-10-01"
-    expect(m["summary"]).to eq "Awesome library"
+    expect(m.name).to eq "awesomelib"
+    expect(m.version).to eq "1.0"
+    expect(m.release_date).to eq "2013-10-01"
+    expect(m.summary).to eq "Awesome library"
 
     expect(mh.manifests.count).to eq 2
-    mh.manifests.each do |manifest|
-      if manifest["schema_type"] == "generic"
-        if manifest["name"] == "commercial"
-          expect(manifest.keys.count).to eq 13
-        else
-          expect(manifest.keys.count).to eq 12
-        end
-      elsif manifest["schema_type"] == "proprietary-release"
-        expect(manifest.keys.count).to eq 15
-      else
-        expect(manifest.keys.count).to eq 17
-      end
-    end
-
-    m = JSON File.read(manifest_filename)
-    expect(m.keys.count).to eq 13
   end
 
   it "creates new manifest" do
@@ -82,21 +66,11 @@ describe Creator do
     
     expect(File.exists?(manifest_filename)).to be true
 
-    mh = ManifestHandler.new settings
-    mh.read_remote
+    m = Manifest.parse_file(manifest_filename)
 
-    expect(mh.libraries.count).to eq 1
-    m = mh.manifest "newawesomelib"
-    expect(m["name"]).to eq "newawesomelib"
-    expect(m["version"]).to eq "edge"
-    expect(m["release_date"]).to eq "2013-09-01"
-    
-    v = Verifier.new settings
-    result = v.verify m
-    if !result.valid?
-      result.print_result
-    end
-    expect(result.valid?).to be true
+    expect(m.name).to eq "newawesomelib"
+    expect(m.version).to eq "edge"
+    expect(m.release_date).to eq "2013-09-01"
   end
 
   it "creates new generic manifest" do
@@ -112,13 +86,6 @@ describe Creator do
     c.create_generic
     
     expect(File.exists?(manifest_filename)).to be true
-
-    v = Verifier.new settings
-    result = v.verify_file manifest_filename
-    if !result.valid?
-      result.print_result
-    end
-    expect(result.valid?).to be true
   end
   
   describe "#create_dir" do

data/spec/unit/downloader_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+include GivenFilesystemSpecHelpers
+
+describe Downloader do
+
+  use_given_filesystem
+
+  include_context "manifest_files"
+  
+  it "downloads source tarball" do
+    mh = ManifestHandler.new(settings)
+    mh.read_remote
+
+    output = double
+    expect(output).to receive(:puts).at_least(:once)
+
+    downloader = Downloader.new(mh, output)
+
+    expect(downloader).to receive(:read_from_url).and_return("dummy tarball")
+
+    path = given_directory
+
+    downloader.download("awesomelib", path)
+
+    tarball_path = File.join(path, "awesomelib-0.2.0.tar.gz")
+
+    expect(File.exists?(tarball_path)).to be true
+    expect(File.read(tarball_path)).to eq "dummy tarball"
+  end
+
+end

data/spec/unit/json_object_spec.rb

@@ -0,0 +1,273 @@
+require_relative "spec_helper.rb"
+
+class MyObject < JsonObject
+  attribute :name
+  attribute :version
+
+  attribute :licenses
+
+  attribute :urls do
+    attribute :homepage
+    attribute :download
+  end
+
+  attribute :custom
+end
+
+class MyDerivedObject < MyObject
+end
+
+class MyOtherObject < JsonObject
+  attribute :hello
+end
+
+describe JsonObject do
+  describe "construction" do
+    it "works when two JsonObjects are defined" do
+      object = MyOtherObject.new
+
+      object.hello = "world"
+
+      expect(object.hello).to eq "world"
+    end
+
+    it "defines internal classes" do
+      object = MyObject.new
+
+      expect(object.urls).to be_a MyObject::Urls
+    end
+
+    it "inherits keys from super class" do
+      expect(MyDerivedObject.all_keys).to include(:name)
+    end
+
+    it "can instantiate sub class" do
+      object = MyDerivedObject.new
+
+      object.name = "Sub Jason"
+      expect(object.name).to eq "Sub Jason"
+    end
+  end
+
+  describe "attributes" do
+    it "defines accessors" do
+      object = MyObject.new
+
+      object.name = "Jason"
+      expect(object.name).to eq "Jason"
+
+      object.version = "1.2.3"
+      expect(object.version).to eq "1.2.3"
+
+      object.licenses = ["GPLv2", "LGPLv2.1"]
+      expect(object.licenses).to eq ["GPLv2", "LGPLv2.1"]
+
+      object.urls.homepage = "http://example.com"
+      expect(object.urls.homepage).to eq "http://example.com"
+    end
+
+    it "returns validity of objects" do
+      object = MyObject.new
+
+      expect(object.valid?).to be false
+      expect(object.urls.valid?).to be false
+
+      object.name = "Jason"
+
+      expect(object.valid?).to be true
+      expect(object.urls.valid?).to be false
+
+      object.urls.homepage = "http://example.com"
+
+      expect(object.valid?).to be true
+      expect(object.urls.valid?).to be true
+    end
+
+    it "returns nil for unset attribute" do
+      json = <<EOT
+{
+  "name": "Jason"
+}
+EOT
+      object = MyDerivedObject.new.from_json(json)
+
+      expect(object.name).to eq "Jason"
+      expect(object.version).to be nil
+    end
+
+    it "raises exception for non-existing attribute" do
+      object = MyObject.new
+
+      expect {
+        object.invalid_attribute
+      }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe "JSON" do
+    before(:all) do
+      @json = <<EOT
+{
+  "name": "Jason",
+  "version": "1.2.3",
+  "licenses": [
+    "GPLv2",
+    "LGPLv2.1"
+  ],
+  "urls": {
+    "homepage": "http://example.com",
+    "download": "http://example.org/download"
+  }
+}
+EOT
+      @json.chomp!
+    end
+
+    describe "reads" do
+      it "from hash" do
+        hash = JSON(@json)
+
+        object = MyObject.new.from_hash(hash)
+        expect(object.class).to be MyObject
+        expect(object.name).to eq "Jason"
+        expect(object.urls.class).to eq MyObject::Urls
+        expect(object.urls.homepage).to eq "http://example.com"
+      end
+
+      it "from JSON" do
+        object = MyObject.new.from_json(@json)
+
+        expect(object.class).to be MyObject
+        expect(object.name).to eq "Jason"
+        expect(object.version).to eq "1.2.3"
+        expect(object.licenses).to eq ["GPLv2", "LGPLv2.1"]
+        expect(object.urls.homepage).to eq "http://example.com"
+        expect(object.urls.download).to eq "http://example.org/download"
+      end
+
+      it "skips schema id" do
+        json = <<EOT
+{
+  "$schema": "abc:xyz",
+  "name": "Jason"
+}
+EOT
+        object = MyObject.new.from_json(json)
+
+        expect(object.name).to eq "Jason"
+      end
+
+      it "hashes as values" do
+        json = <<EOT
+{
+  "$schema": "http://example.com/schema/myobject-v1#",
+  "name": "Jason",
+  "custom": {
+    "one": "1",
+    "two": "2"
+  }
+}
+EOT
+        object = MyObject.new.from_json(json)
+
+        expect(object.name).to eq "Jason"
+        expect(object.custom).to eq({ "one" => "1", "two" => "2" })
+      end
+
+      it "raises exception on unexpected attribute" do
+        json = <<EOT
+{
+  "name": "Jason",
+  "invalid_attribute": "42"
+}
+EOT
+        object = MyObject.new
+        expect {
+          object.from_json(json)
+        }.to raise_error(NoMethodError)
+      end
+    end
+
+    describe "writes" do
+      it "to hash" do
+        object = MyObject.new
+        object.name = "Jason"
+        object.version = "1.2.3"
+        object.licenses = ["GPLv2", "LGPLv2.1"]
+        object.urls.homepage = "http://example.com"
+        object.urls.download = "http://example.org/download"
+
+        expected_hash = {
+          :name => "Jason",
+          :version => "1.2.3",
+          :licenses => ["GPLv2", "LGPLv2.1"],
+          :urls => {
+            :homepage => "http://example.com",
+            :download => "http://example.org/download"
+          }
+        }
+
+        expect(object.to_hash).to eq expected_hash
+      end
+
+      it "to JSON" do
+        expected_json = @json
+
+        object = MyObject.new
+        object.name = "Jason"
+        object.version = "1.2.3"
+        object.licenses = ["GPLv2", "LGPLv2.1"]
+        object.urls.homepage = "http://example.com"
+        object.urls.download = "http://example.org/download"
+
+        expect(object.to_json).to eq expected_json
+      end
+
+      it "only attributes which have a value" do
+        object = MyObject.new
+        object.name = "Jason"
+
+        expected_json = <<EOT
+{
+  "name": "Jason"
+}
+EOT
+        expected_json.chomp!
+
+        expect(object.to_json).to eq expected_json
+      end
+
+      it "schema id" do
+        expected_json = <<EOT
+{
+  "$schema": "http://example.com/schema/myobject-v1#",
+  "name": "Jason"
+}
+EOT
+        expected_json.chomp!
+
+        object = MyObject.new
+        object.schema_id = "http://example.com/schema/myobject-v1#"
+        object.name = "Jason"
+
+        expect(object.to_json).to eq expected_json
+      end
+
+      it "hashes as values" do
+        json = <<EOT
+{
+  "name": "Jason",
+  "custom": {
+    "one": "1",
+    "two": "2"
+  }
+}
+EOT
+
+        object = MyObject.new.from_json(json)
+
+        expect(object.to_json).to eq json.chomp
+      end
+    end
+  end
+end