alveole 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +8 -0
- data/.gitlab-ci.yml +55 -0
- data/.rubocop.yml +63 -0
- data/.rubocop_todo.yml +12 -0
- data/.travis.yml +6 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +171 -0
- data/LICENSE.txt +21 -0
- data/README.md +44 -0
- data/Rakefile +10 -0
- data/alveole.gemspec +35 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/alveole/components/avatar_component/avatar_component.html.slim +6 -0
- data/lib/alveole/components/avatar_component.rb +9 -0
- data/lib/alveole/components/badge_component/badge_component.html.slim +2 -0
- data/lib/alveole/components/badge_component.rb +8 -0
- data/lib/alveole/components/breadcrumb_component/breadcrumb_component.html.slim +2 -0
- data/lib/alveole/components/breadcrumb_component.rb +8 -0
- data/lib/alveole/components/breadcrumbs_component.rb +7 -0
- data/lib/alveole/components/button_component/button_component.html.slim +5 -0
- data/lib/alveole/components/button_component.rb +15 -0
- data/lib/alveole/components/definition_component/definition_component.html.slim +4 -0
- data/lib/alveole/components/definition_component.rb +13 -0
- data/lib/alveole/components/form_component/form_component.html.slim +3 -0
- data/lib/alveole/components/form_component.rb +3 -0
- data/lib/alveole/components/form_submit_component/form_submit_component.html.slim +1 -0
- data/lib/alveole/components/form_submit_component.rb +7 -0
- data/lib/alveole/components/heading_component/heading_component.html.slim +4 -0
- data/lib/alveole/components/heading_component.rb +8 -0
- data/lib/alveole/components/input_component/input_component.html.slim +17 -0
- data/lib/alveole/components/input_component.rb +42 -0
- data/lib/alveole/components/notice_component/notice_component.html.slim +5 -0
- data/lib/alveole/components/notice_component.rb +15 -0
- data/lib/alveole/components/page_component/page_component.html.slim +10 -0
- data/lib/alveole/components/page_component.rb +4 -0
- data/lib/alveole/components/sidebar_component/sidebar_component.html.slim +7 -0
- data/lib/alveole/components/sidebar_component.rb +4 -0
- data/lib/alveole/components/table_column_component/table_column_component.html.slim +3 -0
- data/lib/alveole/components/table_column_component.rb +12 -0
- data/lib/alveole/components/table_component/table_component.html.slim +7 -0
- data/lib/alveole/components/table_component.rb +3 -0
- data/lib/alveole/components/table_header_component/table_header_component.html.slim +2 -0
- data/lib/alveole/components/table_header_component.rb +8 -0
- data/lib/alveole/components/table_row_component/table_row_component.html.slim +4 -0
- data/lib/alveole/components/table_row_component.rb +3 -0
- data/lib/alveole/components/toolbar_component/toolbar_component.html.slim +7 -0
- data/lib/alveole/components/toolbar_component.rb +4 -0
- data/lib/alveole/concerns/bem.rb +21 -0
- data/lib/alveole/engine.rb +30 -0
- data/lib/alveole/helpers/method_helper.rb +31 -0
- data/lib/alveole/javascript/components.js +5 -0
- data/lib/alveole/previews/avatar_component_preview.rb +11 -0
- data/lib/alveole/previews/badge_component_preview.rb +11 -0
- data/lib/alveole/previews/breadcrumb_component_preview.rb +15 -0
- data/lib/alveole/previews/button_component_preview.rb +7 -0
- data/lib/alveole/previews/definition_component_preview.rb +33 -0
- data/lib/alveole/previews/form_component_preview.rb +18 -0
- data/lib/alveole/previews/form_submit_component_preview.rb +7 -0
- data/lib/alveole/previews/heading_component_preview.rb +11 -0
- data/lib/alveole/previews/input_component_preview.rb +32 -0
- data/lib/alveole/previews/notice_component_preview.rb +15 -0
- data/lib/alveole/previews/page_component_preview.rb +33 -0
- data/lib/alveole/previews/sidebar_component_preview.rb +33 -0
- data/lib/alveole/previews/table_column_component_preview.rb +36 -0
- data/lib/alveole/previews/table_component_preview.rb +12 -0
- data/lib/alveole/previews/table_header_component_preview.rb +27 -0
- data/lib/alveole/previews/table_row_component_preview.rb +18 -0
- data/lib/alveole/previews/toolbar_component_preview.rb +33 -0
- data/lib/alveole/version.rb +3 -0
- data/lib/alveole.rb +16 -0
- data/lib/generators/alveole/config_generator.rb +17 -0
- data/lib/generators/alveole/templates/alveole_config.rb +1 -0
- metadata +197 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: b9eb2b2fa6bb60128ca9c7e856154c2acc03c20cd19416946b1c9c1643697eeb
|
4
|
+
data.tar.gz: d21efc1c973809fe2273583dc58ec8f23feab0214dcb07bd84855911aa0602e5
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 5cee3910f174462b9b5860a23abff5ed9d2f8fe781f8a3886647be8f382a3dfdd53eab3b86243a18b7b0b225c04a4d5712b566118cc1f96bb5ffdfad79a39001
|
7
|
+
data.tar.gz: 1afa35c2ef925d920f78a5e12e5c70b61a98d72782a46db56e7735d877f677fb713d060abab1515c1f188a11815f486b0edd3b1314e320c40520f3a8127e5dfb
|
data/.gitignore
ADDED
data/.gitlab-ci.yml
ADDED
@@ -0,0 +1,55 @@
|
|
1
|
+
image: registry.git.captive.fr/captive/systeme/docker/ruby:3.0.2-0-build
|
2
|
+
|
3
|
+
stages:
|
4
|
+
- build
|
5
|
+
- pre-test
|
6
|
+
- test
|
7
|
+
# - release
|
8
|
+
|
9
|
+
cache:
|
10
|
+
key: $CI_PROJECT_NAME
|
11
|
+
paths:
|
12
|
+
- vendor/ruby
|
13
|
+
|
14
|
+
before_script:
|
15
|
+
- git checkout -B "$CI_BUILD_REF_NAME"
|
16
|
+
- bundle config --local path 'vendor'
|
17
|
+
- bundle install
|
18
|
+
|
19
|
+
build:
|
20
|
+
stage: build
|
21
|
+
script:
|
22
|
+
# - bundle exec rake build
|
23
|
+
- gem build alveole.gemspec
|
24
|
+
except:
|
25
|
+
- /^backup\//
|
26
|
+
|
27
|
+
pre-test:lint:rubocop:
|
28
|
+
stage: pre-test
|
29
|
+
script:
|
30
|
+
- bundle exec rubocop -v
|
31
|
+
- bundle exec rubocop -f simple
|
32
|
+
except:
|
33
|
+
- /^backup\//
|
34
|
+
|
35
|
+
# pre-test:lint:slim-lint:
|
36
|
+
# stage: pre-test
|
37
|
+
# script:
|
38
|
+
# - bundle exec slim-lint -v
|
39
|
+
# - bundle exec slim-lint .
|
40
|
+
# except:
|
41
|
+
# - /^backup\//
|
42
|
+
|
43
|
+
test:
|
44
|
+
stage: test
|
45
|
+
script:
|
46
|
+
- bundle exec rake test
|
47
|
+
except:
|
48
|
+
- /^backup\//
|
49
|
+
|
50
|
+
# release:gem:
|
51
|
+
# stage: release
|
52
|
+
# script:
|
53
|
+
# - bundle exec rake release
|
54
|
+
# rules:
|
55
|
+
# - if: '$CI_COMMIT_TAG =~ /^v([0-9]|[1-9][0-9]+)\.([0-9]|[1-9][0-9]+)\.([0-9]|[1-9][0-9]+)$/'
|
data/.rubocop.yml
ADDED
@@ -0,0 +1,63 @@
|
|
1
|
+
inherit_from: .rubocop_todo.yml
|
2
|
+
|
3
|
+
AllCops:
|
4
|
+
NewCops: enable
|
5
|
+
|
6
|
+
Layout/LineLength:
|
7
|
+
Enabled: false
|
8
|
+
|
9
|
+
Layout/SpaceAroundMethodCallOperator:
|
10
|
+
Enabled: true
|
11
|
+
|
12
|
+
Lint/RaiseException:
|
13
|
+
Enabled: true
|
14
|
+
|
15
|
+
Lint/StructNewOverride:
|
16
|
+
Enabled: true
|
17
|
+
|
18
|
+
Lint/EmptyClass:
|
19
|
+
Enabled: false
|
20
|
+
|
21
|
+
Metrics/AbcSize:
|
22
|
+
Max: 50
|
23
|
+
Exclude:
|
24
|
+
- test/**/*
|
25
|
+
|
26
|
+
Metrics/BlockLength:
|
27
|
+
Exclude:
|
28
|
+
- config/**/*
|
29
|
+
- test/**/*
|
30
|
+
- lib/tasks/*
|
31
|
+
|
32
|
+
Metrics/CyclomaticComplexity:
|
33
|
+
Max: 10
|
34
|
+
|
35
|
+
Metrics/ClassLength:
|
36
|
+
Exclude:
|
37
|
+
- test/**/*
|
38
|
+
|
39
|
+
Metrics/MethodLength:
|
40
|
+
Max: 25
|
41
|
+
Exclude:
|
42
|
+
- test/**/*
|
43
|
+
|
44
|
+
Metrics/PerceivedComplexity:
|
45
|
+
Max: 10
|
46
|
+
|
47
|
+
Style/Documentation:
|
48
|
+
Enabled: false
|
49
|
+
|
50
|
+
Style/ExponentialNotation:
|
51
|
+
Enabled: false
|
52
|
+
|
53
|
+
Style/FrozenStringLiteralComment:
|
54
|
+
Enabled: false
|
55
|
+
|
56
|
+
Style/HashEachMethods:
|
57
|
+
Enabled: false
|
58
|
+
|
59
|
+
Style/HashTransformKeys:
|
60
|
+
Enabled: false
|
61
|
+
|
62
|
+
Style/HashTransformValues:
|
63
|
+
Enabled: false
|
data/.rubocop_todo.yml
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
# This configuration was generated by
|
2
|
+
# `rubocop --auto-gen-config`
|
3
|
+
# on 2021-08-18 13:26:25 UTC using RuboCop version 1.18.3.
|
4
|
+
# The point is for the user to remove these configuration records
|
5
|
+
# one by one as the offenses are removed from the code base.
|
6
|
+
# Note that changes in the inspected code, or installation of new
|
7
|
+
# versions of RuboCop, may require this file to be generated again.
|
8
|
+
|
9
|
+
# Offense count: 1
|
10
|
+
# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
|
11
|
+
Metrics/ParameterLists:
|
12
|
+
Max: 8
|
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at marinesourin@live.fr. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [https://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: https://contributor-covenant.org
|
74
|
+
[version]: https://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,171 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
alveole (0.0.1)
|
5
|
+
actionview
|
6
|
+
activesupport (>= 4.1.0)
|
7
|
+
rails
|
8
|
+
view_component (~> 2.35)
|
9
|
+
|
10
|
+
GEM
|
11
|
+
remote: https://rubygems.org/
|
12
|
+
specs:
|
13
|
+
actioncable (6.1.4.1)
|
14
|
+
actionpack (= 6.1.4.1)
|
15
|
+
activesupport (= 6.1.4.1)
|
16
|
+
nio4r (~> 2.0)
|
17
|
+
websocket-driver (>= 0.6.1)
|
18
|
+
actionmailbox (6.1.4.1)
|
19
|
+
actionpack (= 6.1.4.1)
|
20
|
+
activejob (= 6.1.4.1)
|
21
|
+
activerecord (= 6.1.4.1)
|
22
|
+
activestorage (= 6.1.4.1)
|
23
|
+
activesupport (= 6.1.4.1)
|
24
|
+
mail (>= 2.7.1)
|
25
|
+
actionmailer (6.1.4.1)
|
26
|
+
actionpack (= 6.1.4.1)
|
27
|
+
actionview (= 6.1.4.1)
|
28
|
+
activejob (= 6.1.4.1)
|
29
|
+
activesupport (= 6.1.4.1)
|
30
|
+
mail (~> 2.5, >= 2.5.4)
|
31
|
+
rails-dom-testing (~> 2.0)
|
32
|
+
actionpack (6.1.4.1)
|
33
|
+
actionview (= 6.1.4.1)
|
34
|
+
activesupport (= 6.1.4.1)
|
35
|
+
rack (~> 2.0, >= 2.0.9)
|
36
|
+
rack-test (>= 0.6.3)
|
37
|
+
rails-dom-testing (~> 2.0)
|
38
|
+
rails-html-sanitizer (~> 1.0, >= 1.2.0)
|
39
|
+
actiontext (6.1.4.1)
|
40
|
+
actionpack (= 6.1.4.1)
|
41
|
+
activerecord (= 6.1.4.1)
|
42
|
+
activestorage (= 6.1.4.1)
|
43
|
+
activesupport (= 6.1.4.1)
|
44
|
+
nokogiri (>= 1.8.5)
|
45
|
+
actionview (6.1.4.1)
|
46
|
+
activesupport (= 6.1.4.1)
|
47
|
+
builder (~> 3.1)
|
48
|
+
erubi (~> 1.4)
|
49
|
+
rails-dom-testing (~> 2.0)
|
50
|
+
rails-html-sanitizer (~> 1.1, >= 1.2.0)
|
51
|
+
activejob (6.1.4.1)
|
52
|
+
activesupport (= 6.1.4.1)
|
53
|
+
globalid (>= 0.3.6)
|
54
|
+
activemodel (6.1.4.1)
|
55
|
+
activesupport (= 6.1.4.1)
|
56
|
+
activerecord (6.1.4.1)
|
57
|
+
activemodel (= 6.1.4.1)
|
58
|
+
activesupport (= 6.1.4.1)
|
59
|
+
activestorage (6.1.4.1)
|
60
|
+
actionpack (= 6.1.4.1)
|
61
|
+
activejob (= 6.1.4.1)
|
62
|
+
activerecord (= 6.1.4.1)
|
63
|
+
activesupport (= 6.1.4.1)
|
64
|
+
marcel (~> 1.0.0)
|
65
|
+
mini_mime (>= 1.1.0)
|
66
|
+
activesupport (6.1.4.1)
|
67
|
+
concurrent-ruby (~> 1.0, >= 1.0.2)
|
68
|
+
i18n (>= 1.6, < 2)
|
69
|
+
minitest (>= 5.1)
|
70
|
+
tzinfo (~> 2.0)
|
71
|
+
zeitwerk (~> 2.3)
|
72
|
+
ast (2.4.2)
|
73
|
+
builder (3.2.4)
|
74
|
+
concurrent-ruby (1.1.9)
|
75
|
+
crass (1.0.6)
|
76
|
+
erubi (1.10.0)
|
77
|
+
globalid (0.5.2)
|
78
|
+
activesupport (>= 5.0)
|
79
|
+
i18n (1.8.10)
|
80
|
+
concurrent-ruby (~> 1.0)
|
81
|
+
loofah (2.12.0)
|
82
|
+
crass (~> 1.0.2)
|
83
|
+
nokogiri (>= 1.5.9)
|
84
|
+
mail (2.7.1)
|
85
|
+
mini_mime (>= 0.1.1)
|
86
|
+
marcel (1.0.1)
|
87
|
+
method_source (1.0.0)
|
88
|
+
mini_mime (1.1.1)
|
89
|
+
minitest (5.14.4)
|
90
|
+
nio4r (2.5.8)
|
91
|
+
nokogiri (1.12.3-arm64-darwin)
|
92
|
+
racc (~> 1.4)
|
93
|
+
parallel (1.20.1)
|
94
|
+
parser (3.0.1.1)
|
95
|
+
ast (~> 2.4.1)
|
96
|
+
racc (1.5.2)
|
97
|
+
rack (2.2.3)
|
98
|
+
rack-test (1.1.0)
|
99
|
+
rack (>= 1.0, < 3)
|
100
|
+
rails (6.1.4.1)
|
101
|
+
actioncable (= 6.1.4.1)
|
102
|
+
actionmailbox (= 6.1.4.1)
|
103
|
+
actionmailer (= 6.1.4.1)
|
104
|
+
actionpack (= 6.1.4.1)
|
105
|
+
actiontext (= 6.1.4.1)
|
106
|
+
actionview (= 6.1.4.1)
|
107
|
+
activejob (= 6.1.4.1)
|
108
|
+
activemodel (= 6.1.4.1)
|
109
|
+
activerecord (= 6.1.4.1)
|
110
|
+
activestorage (= 6.1.4.1)
|
111
|
+
activesupport (= 6.1.4.1)
|
112
|
+
bundler (>= 1.15.0)
|
113
|
+
railties (= 6.1.4.1)
|
114
|
+
sprockets-rails (>= 2.0.0)
|
115
|
+
rails-dom-testing (2.0.3)
|
116
|
+
activesupport (>= 4.2.0)
|
117
|
+
nokogiri (>= 1.6)
|
118
|
+
rails-html-sanitizer (1.4.1)
|
119
|
+
loofah (~> 2.3)
|
120
|
+
railties (6.1.4.1)
|
121
|
+
actionpack (= 6.1.4.1)
|
122
|
+
activesupport (= 6.1.4.1)
|
123
|
+
method_source
|
124
|
+
rake (>= 0.13)
|
125
|
+
thor (~> 1.0)
|
126
|
+
rainbow (3.0.0)
|
127
|
+
rake (12.3.3)
|
128
|
+
regexp_parser (2.1.1)
|
129
|
+
rexml (3.2.5)
|
130
|
+
rubocop (1.18.3)
|
131
|
+
parallel (~> 1.10)
|
132
|
+
parser (>= 3.0.0.0)
|
133
|
+
rainbow (>= 2.2.2, < 4.0)
|
134
|
+
regexp_parser (>= 1.8, < 3.0)
|
135
|
+
rexml
|
136
|
+
rubocop-ast (>= 1.7.0, < 2.0)
|
137
|
+
ruby-progressbar (~> 1.7)
|
138
|
+
unicode-display_width (>= 1.4.0, < 3.0)
|
139
|
+
rubocop-ast (1.7.0)
|
140
|
+
parser (>= 3.0.1.1)
|
141
|
+
ruby-progressbar (1.11.0)
|
142
|
+
sprockets (4.0.2)
|
143
|
+
concurrent-ruby (~> 1.0)
|
144
|
+
rack (> 1, < 3)
|
145
|
+
sprockets-rails (3.2.2)
|
146
|
+
actionpack (>= 4.0)
|
147
|
+
activesupport (>= 4.0)
|
148
|
+
sprockets (>= 3.0.0)
|
149
|
+
thor (1.1.0)
|
150
|
+
tzinfo (2.0.4)
|
151
|
+
concurrent-ruby (~> 1.0)
|
152
|
+
unicode-display_width (2.0.0)
|
153
|
+
view_component (2.38.0)
|
154
|
+
activesupport (>= 5.0.0, < 8.0)
|
155
|
+
method_source (~> 1.0)
|
156
|
+
websocket-driver (0.7.5)
|
157
|
+
websocket-extensions (>= 0.1.0)
|
158
|
+
websocket-extensions (0.1.5)
|
159
|
+
zeitwerk (2.4.2)
|
160
|
+
|
161
|
+
PLATFORMS
|
162
|
+
ruby
|
163
|
+
|
164
|
+
DEPENDENCIES
|
165
|
+
alveole!
|
166
|
+
minitest (~> 5.0)
|
167
|
+
rake (~> 12.0)
|
168
|
+
rubocop (~> 1.18)
|
169
|
+
|
170
|
+
BUNDLED WITH
|
171
|
+
2.2.22
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2021 Marine Sourin
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,44 @@
|
|
1
|
+
# Alveole
|
2
|
+
|
3
|
+
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/alveole`. To experiment with that code, run `bin/console` for an interactive prompt.
|
4
|
+
|
5
|
+
TODO: Delete this and the text above, and describe your gem
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'alveole'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle install
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install alveole
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
TODO: Write usage instructions here
|
26
|
+
|
27
|
+
## Development
|
28
|
+
|
29
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
30
|
+
|
31
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
32
|
+
|
33
|
+
## Contributing
|
34
|
+
|
35
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/alveole. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/alveole/blob/master/CODE_OF_CONDUCT.md).
|
36
|
+
|
37
|
+
|
38
|
+
## License
|
39
|
+
|
40
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
41
|
+
|
42
|
+
## Code of Conduct
|
43
|
+
|
44
|
+
Everyone interacting in the Alveole project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/alveole/blob/master/CODE_OF_CONDUCT.md).
|