yarnlock 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f585247db16ab766b377683746a6284b41556ef2
-  data.tar.gz: bbf0f0a483546a4f60f224402f7b8581fe7432a8
+  metadata.gz: af3024a8288b05e32849c894d206057929eb3aff
+  data.tar.gz: 63c3d23cc6244661469d2f8e2f0d5ef0d9568a6b
 SHA512:
-  metadata.gz: 6b237ffefa43111e575cd1fb0c08fa180ece8ff3b15a5994d841a8f25545df32db72cd082e439db3ee83bfea470f00af4863e1b77542a277c787e2a31e78aab8
-  data.tar.gz: a6ac1b293b0861019f1077fa5bc53e512dd96d709ee9eb30f6a64afc157f0b9137f384047742bbf80f7ec57ab94bf0e109c69ded58d50e5c0ee08366cb75867b
+  metadata.gz: 4f6c3dd8114faead13890685917e963483836574a56277f865553208d0462f9c9ecf6bfba013788197d2cd2d511d7c5fd90d2c397c45c71506066f87f2dd916d
+  data.tar.gz: a3252b023dc619b85834748278e70fb25001a995d457a397776d9f0475e1cff6e4490e23f09ce041ea18f5bd9138ee9fc6ff868a259729d18d8af749fdef3f09

data/README.md

@@ -36,37 +36,72 @@ require 'yarnlock'
 # Parse string as in yarn.lock:
 parsed = Yarnlock.parse 'yarn_lock_text'
 
+# Stringify parsed object from yarn.lock
+string = Yarnlock.stringify parsed
+
 # Load from file path:
 parsed = Yarnlock.load 'yarn.lock'
-
-# Stringify parsed object from yarn.lock
-Yarnlock.stringify parsed
 ```
 
 ### Parsed object structure
 
-`Yarnlock.parse` returns `Yarnlock::Entry::Collection` object that is actually extends `Hash` and is holding each entries defined at `yarn.lock`.
+Original `parse` function of `@yarnpkg/lockfile` returns pure JSON object in javascript context, so that this library parse JSON and convert it to ruby object for general purpose.
+
+`Yarnlock.parse` returns just an `array` containing each entries defined at `yarn.lock`. Entries are represented as `Yarnlock::Entry` instances. Additionally array extends `Yarnlock::Entry::Collection` module to provide some useful enumeration and JSON serialization.
+
+## API
+
+### `Yarnlock::Entry::Collection`
+
+is a module that is used for `Yarnlock.stringify` to make `string` as same as `yarn.lock`. In other words, You can modify entries and generate customized `yarn.lock` programmatically. Also it provides an enumeration method to retrieve entries for each packages:
+
+#### `package_with_versions` `[Hash<String, <String, Yarnlock::Entry>>]`
+
+returns 2 dimensional hash for iterate package with every resolved versions.
 
-That hash has 3 dimension, such like:
+- The key of 1st level is the package name that is found on [Yarn repository](https://yarnpkg.com), can be used for dependency specification in package.json.
+- The key of 2nd level is the resolved version for range of versions. It is parsed as `Semantic::Version`
+- The value is `Yarnlock.Entry` instance.
+
+For example:
 
 ```ruby
-parsed['@yarnpkg/lockfile']['1.0.0'] = Yarnlock::Entry.new
+yarnlock = Yarnlock.load 'yarn.lock'
+yarnlock.package_with_versions.each do |package, versions|
+  puts package # '@yarnpkg/lockfile'
+  versions.each do |version, entry|
+    puts version # <Semantic::Version:0x007fe286056110 @major=1, @minor=0, @patch=0, @pre=nil, @build=nil, @version="1.0.0">
+    puts entry.resolved # 'https://registry.yarnpkg.com/@yarnpkg/lockfile/-/lockfile-1.0.0.tgz#33d1dbb659a23b81f87f048762b35a446172add3'
+  end
+end
+```
+
+
+#### `highest_version_packages` `[Hash<String, Yarnlock::Entry>]`
+
+returns hash keyed by package, valued by entry. Since `yarn install` command will install highest resolved version of each package, You can take such package + version pair like:
+
+```ruby
+yarnlock = Yarnlock.load 'yarn.lock'
+yarnlock.highest_version_packages.each do |package, entry|
+  puts package # '@yarnpkg/lockfile'
+  puts entry.version # <Semantic::Version:0x007fe286056110 @major=1, @minor=0, @patch=0, @pre=nil, @build=nil, @version="1.0.0">
+  puts entry.resolved # 'https://registry.yarnpkg.com/@yarnpkg/lockfile/-/lockfile-1.0.0.tgz#33d1dbb659a23b81f87f048762b35a446172add3'
+end
 ```
 
-The key of 1st level is the package name that is found on [Yarn repository](https://yarnpkg.com), can be used for dependency specification in `package.json`.
-The key of 2nd level is the resolved version for range of versions.
-The value is `Yarnlock.Entry` object that represents a entry of `yarn.lock`.
+### `Yarnlock::Entry`
 
-`Yarnlock.Entry` is a pure class that holds parsed information from a entry. You can access attribute to get information what you need:
+is a pure class that holds parsed information from a entry. You can access attribute to get information what you need:
 
-- `package` `[String]` The package name. Same as 1st level key of `Yarnlock::Entry::Collection`.
-- `package` `[String]` Resolved version. Same as 2nd level key of `Yarnlock::Entry::Collection`.
+- `package` `[String]` The package name.
+- `version` `[Semantic::Version]` Resolved version. This is not a just string but a `Semantic::Version` object to useful for compare for. See  [jlindsey/semantic: Ruby Semantic Version class](https://github.com/jlindsey/semantic/) for details.
 - `version_ranges` `[Array]` Version ranges, this holds multiple ranges like `['^2.1.0', '^2.1.1']`.
   - You can see like `"@yarnpkg/lockfile@^1.0.0":` in `yarn.lock`, range of versions is `^1.0.0` of that, specified by `*dependencies` at `package.json` and its sub dependencies.
 - `resolved` `[String]` Resolved registry location for tar ball.
 - `dependencies` `[Hash]` Sub dependencies keyed by package name and valued by version range.
 
-### Options
+## Options
 
 You can configure some options to change behavior like:
 

data/lib/yarnlock.rb

@@ -23,7 +23,7 @@ module Yarnlock
     parsed = JSON.parse json_string
 
     raise "An error was occurred when parsing yarn.lock: #{parsed}" unless parsed.is_a? Hash
-    raise "Could not parse yarn.lock: #{parsed['reason']}" unless parsed['type'] == 'success'
+    raise "Could not parse yarn.lock: #{parsed['reason']}" if parsed['type'] == 'failure'
 
     return parsed['object'] unless config.return_collection
     Entry::Collection.parse parsed['object']
@@ -34,7 +34,7 @@ module Yarnlock
     parsed = JSON.parse json_string
 
     raise "An error was occurred when stringing object: #{parsed}" unless parsed.is_a? Hash
-    raise "Could not stringing object: #{parsed['reason']}" unless parsed['type'] == 'success'
+    raise "Could not stringing object: #{parsed['reason']}" if parsed['type'] == 'failure'
 
     parsed['yarnlock']
   end

data/lib/yarnlock/entry.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'semantic/core_ext'
+
 module Yarnlock
   class Entry
     attr_accessor :package, :version_ranges, :version, :resolved, :dependencies
@@ -15,7 +17,7 @@ module Yarnlock
         @version_ranges << version_range
       end
 
-      @version = entry['version']
+      @version = entry['version'].to_version
       @resolved = entry['resolved']
       @dependencies = entry['dependencies']
 
@@ -28,7 +30,7 @@ module Yarnlock
       end.join(', ')
       {
         pattern => {
-          'version' => version,
+          'version' => version.to_s,
           'resolved' => resolved,
           'dependencies' => dependencies
         }.reject { |_, v| v.nil? } # Hash#compact is not supported in Ruby < 2.4

data/lib/yarnlock/entry/collection.rb

@@ -1,26 +1,33 @@
 # frozen_string_literal: true
 
+require 'semantic'
+
 module Yarnlock
   class Entry
-    class Collection < Hash
+    module Collection
       def self.parse(raw_entries)
-        collection = new
-        raw_entries.each do |pattern, raw_entry|
-          entry = Yarnlock::Entry.parse pattern, raw_entry
-          collection[entry.package] ||= {}
-          collection[entry.package][entry.version] = entry
+        raw_entries.map do |pattern, raw_entry|
+          Entry.parse pattern, raw_entry
+        end.extend(self)
+      end
+
+      def package_with_versions
+        each_with_object({}) do |entry, packages|
+          packages[entry.package] ||= {}
+          packages[entry.package][entry.version] = entry
+        end
+      end
+
+      def highest_version_packages
+        each_with_object({}) do |entry, packages|
+          packages[entry.package] = [entry, packages[entry.package]].compact.max_by(&:version)
         end
-        collection
       end
 
       def as_json(_options = {})
-        entries = {}
-        each_value do |versions|
-          versions.each_value do |entry|
-            entries.merge! entry.to_h
-          end
+        each_with_object({}) do |entry, entries|
+          entries.merge! entry.to_h
         end
-        entries
       end
 
       def to_json(*options)

data/lib/yarnlock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yarnlock
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/yarnlock.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'semantic', '~> 1.6'
+
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yarnlock
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Hiroki Shimizu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2018-03-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: semantic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement