Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
d3490f69
Commit
d3490f69
authored
6 years ago
by
Nick Thomas
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Introduce a LicenseTemplate model and LicenseTemplateFinder helper
parent
ffd164d2
Changes
4
Show whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
197 additions
and
0 deletions
+197
-0
app/finders/license_template_finder.rb
app/finders/license_template_finder.rb
+36
-0
app/models/license_template.rb
app/models/license_template.rb
+53
-0
spec/finders/license_template_finder_spec.rb
spec/finders/license_template_finder_spec.rb
+49
-0
spec/models/license_template_spec.rb
spec/models/license_template_spec.rb
+59
-0
No files found.
app/finders/license_template_finder.rb
0 → 100644
View file @
d3490f69
# LicenseTemplateFinder
#
# Used to find license templates, which may come from a variety of external
# sources
#
# Arguments:
# popular: boolean. When set to true, only "popular" licenses are shown. When
# false, all licenses except popular ones are shown. When nil (the
# default), *all* licenses will be shown.
class
LicenseTemplateFinder
attr_reader
:params
def
initialize
(
params
=
{})
@params
=
params
end
def
execute
Licensee
::
License
.
all
(
featured:
popular_only?
).
map
do
|
license
|
LicenseTemplate
.
new
(
id:
license
.
key
,
name:
license
.
name
,
nickname:
license
.
nickname
,
category:
(
license
.
featured?
?
:Popular
:
:Other
),
content:
license
.
content
,
url:
license
.
url
,
meta:
license
.
meta
)
end
end
private
def
popular_only?
params
.
fetch
(
:popular
,
nil
)
end
end
This diff is collapsed.
Click to expand it.
app/models/license_template.rb
0 → 100644
View file @
d3490f69
class
LicenseTemplate
PROJECT_TEMPLATE_REGEX
=
%r{[
\<\{\[
]
(project|description|
one
\s
line
\s
.+
\s
what
\s
it
\s
does
\.
) # matching the start and end is enough here
[
\>\}\]
]}xi
.
freeze
YEAR_TEMPLATE_REGEX
=
/[<{\[](year|yyyy)[>}\]]/i
.
freeze
FULLNAME_TEMPLATE_REGEX
=
%r{[
\<\{\[
]
(fullname|name
\s
of
\s
(author|copyright
\s
owner))
[
\>\}\]
]}xi
.
freeze
attr_reader
:id
,
:name
,
:category
,
:nickname
,
:url
,
:meta
alias_method
:key
,
:id
def
initialize
(
id
:,
name
:,
category
:,
content
:,
nickname:
nil
,
url:
nil
,
meta:
{})
@id
=
id
@name
=
name
@category
=
category
@content
=
content
@nickname
=
nickname
@url
=
url
@meta
=
meta
end
def
popular?
category
==
:Popular
end
alias_method
:featured?
,
:popular?
# Returns the text of the license
def
content
if
@content
.
respond_to?
(
:call
)
@content
=
@content
.
call
else
@content
end
end
# Populate placeholders in the LicenseTemplate content
def
resolve!
(
project_name:
nil
,
fullname:
nil
,
year:
Time
.
now
.
year
.
to_s
)
# Ensure the string isn't shared with any other instance of LicenseTemplate
new_content
=
content
.
dup
new_content
.
gsub!
(
YEAR_TEMPLATE_REGEX
,
year
)
if
year
.
present?
new_content
.
gsub!
(
PROJECT_TEMPLATE_REGEX
,
project_name
)
if
project_name
.
present?
new_content
.
gsub!
(
FULLNAME_TEMPLATE_REGEX
,
fullname
)
if
fullname
.
present?
@content
=
new_content
self
end
end
This diff is collapsed.
Click to expand it.
spec/finders/license_template_finder_spec.rb
0 → 100644
View file @
d3490f69
require
'spec_helper'
describe
LicenseTemplateFinder
do
describe
'#execute'
do
subject
(
:result
)
{
described_class
.
new
(
params
).
execute
}
let
(
:categories
)
{
categorised_licenses
.
keys
}
let
(
:categorised_licenses
)
{
result
.
group_by
(
&
:category
)
}
context
'popular: true'
do
let
(
:params
)
{
{
popular:
true
}
}
it
'only returns popular licenses'
do
expect
(
categories
).
to
contain_exactly
(
:Popular
)
expect
(
categorised_licenses
[
:Popular
]).
to
be_present
end
end
context
'popular: false'
do
let
(
:params
)
{
{
popular:
false
}
}
it
'only returns unpopular licenses'
do
expect
(
categories
).
to
contain_exactly
(
:Other
)
expect
(
categorised_licenses
[
:Other
]).
to
be_present
end
end
context
'popular: nil'
do
let
(
:params
)
{
{
popular:
nil
}
}
it
'returns all licenses known by the Licensee gem'
do
from_licensee
=
Licensee
::
License
.
all
.
map
{
|
l
|
l
.
key
}
expect
(
result
.
map
(
&
:id
)).
to
match_array
(
from_licensee
)
end
it
'correctly copies all attributes'
do
licensee
=
Licensee
::
License
.
all
.
first
found
=
result
.
find
{
|
r
|
r
.
key
==
licensee
.
key
}
aggregate_failures
do
%i[key name content nickname url meta featured?]
.
each
do
|
k
|
expect
(
found
.
public_send
(
k
)).
to
eq
(
licensee
.
public_send
(
k
))
end
end
end
end
end
end
This diff is collapsed.
Click to expand it.
spec/models/license_template_spec.rb
0 → 100644
View file @
d3490f69
require
'spec_helper'
describe
LicenseTemplate
do
describe
'#content'
do
it
'calls a proc exactly once if provided'
do
lazy
=
build_template
(
->
{
'bar'
})
content
=
lazy
.
content
expect
(
content
).
to
eq
(
'bar'
)
expect
(
content
.
object_id
).
to
eq
(
lazy
.
content
.
object_id
)
content
.
replace
(
'foo'
)
expect
(
lazy
.
content
).
to
eq
(
'foo'
)
end
it
'returns a string if provided'
do
lazy
=
build_template
(
'bar'
)
expect
(
lazy
.
content
).
to
eq
(
'bar'
)
end
end
describe
'#resolve!'
do
let
(
:content
)
do
<<~
TEXT
Pretend License
[project]
Copyright (c) [year] [fullname]
TEXT
end
let
(
:expected
)
do
<<~
TEXT
Pretend License
Foo Project
Copyright (c) 1985 Nick Thomas
TEXT
end
let
(
:template
)
{
build_template
(
content
)
}
it
'updates placeholders in a copy of the template content'
do
expect
(
template
.
content
.
object_id
).
to
eq
(
content
.
object_id
)
template
.
resolve!
(
project_name:
"Foo Project"
,
fullname:
"Nick Thomas"
,
year:
"1985"
)
expect
(
template
.
content
).
to
eq
(
expected
)
expect
(
template
.
content
.
object_id
).
not_to
eq
(
content
.
object_id
)
end
end
def
build_template
(
content
)
described_class
.
new
(
id:
'foo'
,
name:
'foo'
,
category: :Other
,
content:
content
)
end
end
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment