Skip to content
This repository was archived by the owner on Sep 29, 2025. It is now read-only.

Commit 1415612

Browse files
dblockdblock
committed
Initial commit, gem skeleton.
0 parents  commit 1415612

28 files changed

+586
-0
lines changed

‎.gitignore‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.DS_Store
2+
.rvmrc
3+
.irbrc
4+
.bundle
5+
log
6+
.env
7+
*.swp
8+
Gemfile.lock
9+
.ruby-version
10+
pkg

‎.rspec‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
--color
2+
--format=documentation
3+

‎.rubocop.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Metrics:
2+
Enabled: false
3+
4+
Layout/LineLength:
5+
Max: 500
6+
Enabled: false
7+
8+
Style/Documentation:
9+
Enabled: false
10+
11+
Style/ModuleFunction:
12+
EnforcedStyle: extend_self
13+
14+
inherit_from: .rubocop_todo.yml
15+

‎.rubocop_todo.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# This configuration was generated by
2+
# `rubocop --auto-gen-config`
3+
# on 2020-10-14 08:19:11 -0400 using RuboCop version 0.81.0.
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: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
11+
# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
12+
Naming/FileName:
13+
Exclude:
14+
- 'lib/slack-ruby-bot-server-rtm.rb'

‎.travis.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
language: ruby
2+
3+
cache: bundler
4+
5+
matrix:
6+
include:
7+
- rvm: 2.6.6
8+
script:
9+
- bundle exec danger
10+
- rvm: 2.6.6
11+
env: DATABASE_ADAPTER=activerecord
12+
services:
13+
- postgresql
14+
- rvm: 2.6.6
15+
env: DATABASE_ADAPTER=mongoid
16+
services:
17+
- mongodb

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
### Changelog
2+
3+
#### 0.1.0 (Next)
4+
5+
* Initial public release - [@dblock](https://github.com/dblock).

‎CONTRIBUTING.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
# Contributing to SlackRubyBotServer::RealTime
2+
3+
This project is work of [many contributors](https://github.com/slack-ruby/slack-ruby-bot-server-rtm/graphs/contributors).
4+
5+
You're encouraged to submit [pull requests](https://github.com/slack-ruby/slack-ruby-bot-server-rtm/pulls), [propose features and discuss issues](https://github.com/slack-ruby/slack-ruby-bot-server-rtm/issues).
6+
7+
In the examples below, substitute your Github username for `contributor` in URLs.
8+
9+
## Fork the Project
10+
11+
Fork the [project on Github](https://github.com/slack-ruby/slack-ruby-bot-server-rtm) and check out your copy.
12+
13+
```
14+
git clone https://github.com/contributor/slack-ruby-bot-server-rtm.git
15+
cd slack-ruby-bot-server-rtm
16+
git remote add upstream https://github.com/slack-ruby/slack-ruby-bot-server-rtm.git
17+
```
18+
19+
## Create a Topic Branch
20+
21+
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
22+
23+
```
24+
git checkout master
25+
git pull upstream master
26+
git checkout -b my-feature-branch
27+
```
28+
29+
## Bundle Install and Test
30+
31+
Ensure that you can build the project and run tests.
32+
33+
```
34+
bundle install
35+
bundle exec rake
36+
```
37+
38+
## Write Tests
39+
40+
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
41+
Add to [spec](spec).
42+
43+
We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
44+
45+
## Write Code
46+
47+
Implement your feature or bug fix.
48+
49+
Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop).
50+
Run `bundle exec rubocop` and fix any style issues highlighted.
51+
52+
Make sure that `bundle exec rake` completes without errors.
53+
54+
## Write Documentation
55+
56+
Document any external behavior in the [README](README.md).
57+
58+
## Update Changelog
59+
60+
Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*.
61+
Make it look like every other line, including your name and link to your Github account.
62+
63+
## Commit Changes
64+
65+
Make sure git knows your name and email address:
66+
67+
```
68+
git config --global user.name "Your Name"
69+
git config --global user.email "[email protected]"
70+
```
71+
72+
Writing good commit logs is important. A commit log should describe what changed and why.
73+
74+
```
75+
git add ...
76+
git commit
77+
```
78+
79+
## Push
80+
81+
```
82+
git push origin my-feature-branch
83+
```
84+
85+
## Make a Pull Request
86+
87+
Go to https://github.com/contributor/slack-ruby-bot-server-rtm and select your feature branch.
88+
Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
89+
90+
## Rebase
91+
92+
If you've been working on a change for a while, rebase with upstream/master.
93+
94+
```
95+
git fetch upstream
96+
git rebase upstream/master
97+
git push origin my-feature-branch -f
98+
```
99+
100+
## Update CHANGELOG Again
101+
102+
Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
103+
104+
```
105+
* [#123](https://github.com/slack-ruby/slack-ruby-bot-server-rtm/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
106+
```
107+
108+
Amend your previous commit and force push the changes.
109+
110+
```
111+
git commit --amend
112+
git push origin my-feature-branch -f
113+
```
114+
115+
## Check on Your Pull Request
116+
117+
Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
118+
119+
## Be Patient
120+
121+
It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
122+
123+
## Thank You
124+
125+
Please do know that we really appreciate and value your time and work. We love you, really.

‎Dangerfile‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# frozen_string_literal: true
2+
3+
danger.import_dangerfile(gem: 'slack-ruby-danger')

‎Gemfile‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# frozen_string_literal: true
2+
3+
source 'https://rubygems.org'
4+
5+
case ENV['DATABASE_ADAPTER']
6+
when 'mongoid' then
7+
gem 'kaminari-mongoid'
8+
gem 'mongoid'
9+
gem 'mongoid-scroll'
10+
when 'activerecord' then
11+
gem 'activerecord', '~> 5.0.0'
12+
gem 'otr-activerecord', '~> 1.2.1'
13+
gem 'virtus'
14+
gem 'cursor_pagination' # rubocop:disable Bundler/OrderedGems
15+
gem 'pg'
16+
when nil
17+
warn "Missing ENV['DATABASE_ADAPTER']."
18+
else
19+
warn "Invalid ENV['DATABASE_ADAPTER']: #{ENV['DATABASE_ADAPTER']}."
20+
end
21+
22+
gemspec
23+
24+
group :development, :test do
25+
gem 'bundler'
26+
gem 'database_cleaner'
27+
gem 'fabrication'
28+
gem 'faker'
29+
gem 'hyperclient'
30+
gem 'rack-test'
31+
gem 'rake'
32+
gem 'rspec'
33+
gem 'rubocop', '0.81.0'
34+
gem 'vcr'
35+
gem 'webmock'
36+
end
37+
38+
group :test do
39+
gem 'slack-ruby-danger', '~> 0.1.0', require: false
40+
end

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2020 Daniel Doubrovkine & Contributors
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 all
13+
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 THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)