toller 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +22 -22
  3. data/lib/toller/version.rb +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ef1cb1cdd4eda93e78a06a6a726cbacc8691a5432b9093d5e528b134f684e394
4
- data.tar.gz: 0b2cb5c9c7bab4e19071a1dbc714753f165fe4860122df2cba22f4374fd278e5
3
+ metadata.gz: 35290d3f9b21adb7834fbf214f71655f6d71628742e2e18ddee3de86e6b4b45f
4
+ data.tar.gz: 390975016fc9236a125340538fbd3a565924392ab6a3c68c6794928ceb38522d
5
5
  SHA512:
6
- metadata.gz: c6995cbd28ce74007d49e19bc3640a304376a2ada91b5af20dff6f19ac4326c7955e1f988b5d5d7f820c88e2a1b87715cb5b3007e3d0b31ad35b6844c87294da
7
- data.tar.gz: 8878b663705932090157405b807d3b8ac3530c6cccbd0e45da6ade3c8aa6bcabecdc2a60d82b8a1d1081f31e04e81b25eac1db00f0c8f9684762ec7975b050e3
6
+ metadata.gz: 2907a0aafb8c1fbb9e6c0b021778081874fd10263a7f970c9a0142f9f706decf433837fea12b9408de8983759417c9417eab02a008c969359aabf6336df777fa
7
+ data.tar.gz: 3e788653d93fff2e613501c48a1dde8eec9514676481a8680b4e28bfcafef341e8dc29a75bbe1bbfb60c905681ed18fb5c36895549118e81063d52ca6fcc5fc8
data/README.md CHANGED
@@ -20,34 +20,17 @@ $ bundle install
20
20
 
21
21
  Filters are not automagically set up for you. You define the filters you want.
22
22
 
23
- ### Filter Types
23
+ Filtering parameters are passed in the URL as such `?filters[visible]=1`. Multiple filter parameters can be passed like so `?filters[visible]=1&filters[published_after]=2020-07-04`.
24
24
 
25
- * integer - Filter on an integer column
26
- * boolean - Filter on a boolean column
27
- * string - Filter on a string column
28
- * text - Filter on a text column
29
- * date - Filter on a date column
30
- * time - Filter on a time column
31
- * datetime - Filter on a datetime column
32
- * scope - Filter on an ActiveRecord scope
25
+ More information is [available in the wiki](https://github.com/dfreerksen/toller/wiki/Filter).
33
26
 
34
- ## Sort
27
+ ## Sorting
35
28
 
36
29
  Sorting is not automagically set up for you. You define the sorting you want.
37
30
 
38
- Sort parameters are passed in the URL as such `?sort=position`. Multiple sort parameters can be passed like so `?sort=-published_at,title`.
31
+ Sorting parameters are passed in the URL as such `?sort=position`. Multiple sort parameters can be passed like so `?sort=-published_at,title`.
39
32
 
40
- ### Sort Types
41
-
42
- Every sort must have a type. Valid sort types are:
43
-
44
- * integer - Sort on an integer column
45
- * string - Sort on a string column
46
- * text - Sort on a text column
47
- * date - Sort on a date column
48
- * time - Sort on a time column
49
- * datetime - Sort on a datetime column
50
- * scope - Sort on an ActiveRecord scope
33
+ More information is [available in the wiki](https://github.com/dfreerksen/toller/wiki/Sort).
51
34
 
52
35
  ## Testing
53
36
 
@@ -55,6 +38,23 @@ Every sort must have a type. Valid sort types are:
55
38
  $ bin/test
56
39
  ```
57
40
 
41
+ ## Release
42
+
43
+ 1. Bump the gem version in `lib/toller/version.rb`
44
+ 2. Build the gem with
45
+
46
+ ```
47
+ $ bundle exec rake build
48
+ ```
49
+
50
+ This will create a new .gem file in `pkg/`. Fix any errors or warnings that come up.
51
+ 3. Commit the version change to git with a commit message similar to "Release [X.Y.Z]"
52
+ 4. Create the gem, tag it in Github and release to Rubygems
53
+
54
+ ```
55
+ $ bundle exec rake release
56
+ ```
57
+
58
58
  ## Contributing
59
59
 
60
60
  1. Fork it ([https://github.com/dfrerksen/recieve/fork](https://github.com/dfrerksen/recieve/fork))
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Toller
4
- VERSION = '0.3.0'
4
+ VERSION = '0.4.0'
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: toller
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - David Freerksen