Class: Gemstar::RubyGemsMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/gemstar/ruby_gems_metadata.rb

Constant Summary collapse

RUBY_GEMS_METADATA_PATH = 
File.expand_path("data/ruby_gems_metadata.json", __dir__)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(gem_name) ⇒ RubyGemsMetadata

Returns a new instance of RubyGemsMetadata.



12
13
14
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 12

def initialize(gem_name)
  @gem_name = gem_name
end

Instance Attribute Details

#gem_name ⇒ Object (readonly)

Returns the value of attribute gem_name.



16
17
18
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 16

def gem_name
  @gem_name
end

Class Method Details

.package_metadata ⇒ Object 



18
19
20
21
22
23
24
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 18

def self.package_metadata
  @package_metadata ||= begin
    JSON.parse(File.read(RUBY_GEMS_METADATA_PATH))
  rescue Errno::ENOENT, JSON::ParserError
    {}
  end
end

Instance Method Details

#cache_key ⇒ Object 



26
27
28
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 26

def cache_key
  "rubygems-#{gem_name}"
end

#changelog_sections(versions: nil, cache_only: false, force_refresh: false) ⇒ Object 



91
92
93
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 91

def changelog_sections(versions: nil, cache_only: false, force_refresh: false)
  Gemstar::ChangeLog.new(self).sections(cache_only: cache_only, force_refresh: force_refresh)
end

#changelog_source(repo_uri:, cache_only: false, force_refresh: false) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 136

def changelog_source(repo_uri:, cache_only: false, force_refresh: false)
  override = package_metadata.dig("changelog")
  if override
    override_paths = Array(override["paths"]).compact
    override_branches = Array(override["branches"]).compact
    override_branches = [""] if override_branches.empty? && override["raw_base"]
    return {
      base: expand_metadata_template(override["raw_base"] || github_raw_base(repo_uri)),
      paths: override_paths.empty? ? Gemstar::ChangeLog::DEFAULT_CHANGELOG_PATHS : override_paths,
      branches: override_branches.empty? ? RemoteRepository.new(github_raw_base(repo_uri)).find_main_branch(cache_only: cache_only, force_refresh: force_refresh) : override_branches
    }
  end

  base = github_raw_base(repo_uri)
  {
    base: base,
    paths: Gemstar::ChangeLog::DEFAULT_CHANGELOG_PATHS,
    branches: RemoteRepository.new(base).find_main_branch(cache_only: cache_only, force_refresh: force_refresh)
  }
end

#discover_github_tag_sections? ⇒ Boolean

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 123

def discover_github_tag_sections?
  false
end

#github_tag_candidates(version) ⇒ Object 



127
128
129
130
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 127

def github_tag_candidates(version)
  raw = version.to_s
  [raw, (raw.start_with?("v") ? raw : "v#{raw}")].uniq
end

#github_tag_matches?(tag_name) ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 132

def github_tag_matches?(tag_name)
  true
end

#meta(cache_only: false, force_refresh: false) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 30

def meta(cache_only: false, force_refresh: false)
  return @meta if !cache_only && defined?(@meta)

  json = if cache_only
    Cache.peek(cache_key)
  else
    url = "https://rubygems.org/api/v1/gems/#{URI.encode_www_form_component(gem_name)}.json"
    Cache.fetch(cache_key, force: force_refresh) do
      URI.open(url).read
    end
  end

  parsed = begin
    JSON.parse(json) if json
  rescue
    nil
  end

  @meta = parsed unless cache_only
  parsed
end

#package_metadata ⇒ Object 



157
158
159
160
161
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 157

def package_metadata
  self.class.package_metadata.find do |pattern, _metadata|
    File.fnmatch?(pattern, gem_name)
  end&.last || {}
end

#registry_release_dates(cache_only: false, force_refresh: false) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 95

def registry_release_dates(cache_only: false, force_refresh: false)
  cache_key = "rubygems-versions-#{gem_name}"
  json = if cache_only
    Cache.peek(cache_key)
  else
    url = "https://rubygems.org/api/v1/versions/#{URI.encode_www_form_component(gem_name)}.json"
    Cache.fetch(cache_key, force: force_refresh) do
      URI.open(url, read_timeout: 8).read
    end
  end

  Array(JSON.parse(json)).each_with_object({}) do |version, dates|
    number = version["number"].to_s
    created_at = version["created_at"].to_s
    next if number.empty? || created_at.empty?

    dates[number] = format_registry_release_date(created_at)
  end.compact
rescue JSON::ParserError
  {}
end

#repo_uri(cache_only: false, force_refresh: false) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 52

def repo_uri(cache_only: false, force_refresh: false)
  resolved_meta = meta(cache_only: cache_only, force_refresh: force_refresh)
  return nil unless resolved_meta

  return @repo_uri if !cache_only && defined?(@repo_uri)

  repo = begin
           uri = resolved_meta["source_code_uri"]

           if uri.nil?
             uri = resolved_meta["homepage_uri"]
             if uri&.include?("github.com")
               uri = uri[%r{http[s?]://github\.com/[^/]+/[^/]+}]
             end
           end

           uri ||= ""

           uri = uri.sub("http://", "https://")

           uri = uri.gsub(/\.git$/, "")

           if uri.include?("github.io")
             uri = uri.sub(%r{\Ahttps?://([\w-]+)\.github\.io/([^/]+)}) do
               "https://github.com/#{$1}/#{$2}"
             end
           end

           if uri.include?("github.com")
             uri = uri[%r{\Ahttps?://github\.com/[^/]+/[^/]+}] || uri
           end

           uri
         end

  @repo_uri = repo unless cache_only
  repo
end

#warm_cache(versions: nil) ⇒ Object 



117
118
119
120
121
 
# File 'lib/gemstar/ruby_gems_metadata.rb', line 117

def warm_cache(versions: nil)
  meta
  repo_uri
  changelog_sections(versions: versions)
end