solidus 1.0.0.pre → 1.0.0.pre2

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 (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +68 -165
  3. metadata +14 -15
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: c9879605ee40d8de5832f4cf58d178cd9ae82a98
4
- data.tar.gz: e47654128e3ba531ac63dae14a09a5fa9179c24b
3
+ metadata.gz: 7cfb9c72c42087684269631a4fd05eda30606d36
4
+ data.tar.gz: 8c3d8e192f19232d22c2e32cac1da5b17b5b70a7
5
5
  SHA512:
6
- metadata.gz: 9bd502c1df6943f11d479a6277a9e2417ffec80349983b2124d0b6a884ac5d105cbcf113d7e6ab2d88d56322fff64bf52dd119e060ddcc7eefaa920013bacad5
7
- data.tar.gz: 3331411f2259665886a62005f45be06212fe71395a591b49c79a11535dcd88de69954fd96233ed87b993bf7feee608e87612ce73de74ffb72d3f59d1d45d9f4b
6
+ metadata.gz: e37a799b294e4472c6234b86a62013e693ff4497c3020798be6b8576e656724eb771f444d28445eb09905ad8781f0037fabc246642579cd06e9e61a51e25e8f8
7
+ data.tar.gz: 2d0cb0536d4fa09c1c341b6945341700374c01814d9ed4d81d1d30d5b18755486c982583b8b75a31b5d9e82f8eeb578a369b47aa043703962677549afd1bbe85
data/README.md CHANGED
@@ -13,9 +13,9 @@ in a single repository and documented in a single set of
13
13
  solidus gem you automatically require all of the necessary gem dependencies which are:
14
14
 
15
15
  * solidus\_api (RESTful API)
16
- * solidus\_frontend (User-facing components)
16
+ * solidus\_frontend (Cart and storefront)
17
17
  * solidus\_backend (Admin area)
18
- * solidus\_core (Models & Mailers, the basic components of Solidus that it can't run without)
18
+ * solidus\_core (Essential models, mailers, and classes)
19
19
  * solidus\_sample (Sample data)
20
20
 
21
21
  All of the gems are designed to work together to provide a fully functional
@@ -55,20 +55,21 @@ Run migrations to create the new models in the database.
55
55
  bundle exec rake db:migrate
56
56
  ```
57
57
 
58
+ Finally start the rails server
58
59
 
59
- Using stable builds and bleeding edge
60
- -------------
60
+ ```
61
+ bundle exec rails s
62
+ ````
61
63
 
62
- To use a stable build of Spree, you can manually add Spree to your
63
- Rails application. To use the 2-4-stable branch of Spree, add this line to
64
- your Gemfile.
64
+ The solidus_frontend storefront will be accessible at http://localhost:3000/
65
+ and the admin can be found at http://localhost:3000/admin/.
65
66
 
66
- ```ruby
67
- gem 'solidus'
68
- ```
69
67
 
70
- Alternatively, if you want to use the bleeding edge version of Solidus, use this
71
- line:
68
+ Installation options
69
+ --------------------
70
+
71
+ Instead of a stable build, if you want to use the bleeding edge version of
72
+ Solidus, use this line:
72
73
 
73
74
  ```ruby
74
75
  gem 'solidus', github: 'solidusio/solidus'
@@ -78,46 +79,14 @@ gem 'solidus', github: 'solidusio/solidus'
78
79
  state. It is unwise to use this branch in a production system you care deeply
79
80
  about.**
80
81
 
81
- If you wish to have authentication included also, you will need to add the
82
- `solidus_auth_devise` gem as well.
83
-
84
- ```ruby
85
- gem 'solidus_auth_devise'
86
- ```
87
-
88
- Once you've done that, then you can install these gems using this command:
89
-
90
- ```shell
91
- bundle install
92
- ```
93
-
94
- Use the install generator to set up Solidus:
95
-
96
- ```shell
97
- rails g spree:install --sample=false --seed=false
98
- ```
99
-
100
- At this point, if you are using solidus\_auth\_devise you will need to change this
101
- line in `config/initializers/spree.rb`:
102
-
103
- ```ruby
104
- Spree.user_class = "Spree::LegacyUser"
105
- ```
106
-
107
- To this:
108
-
109
- ```ruby
110
- Spree.user_class = "Spree::User"
111
- ```
112
-
113
- You can avoid running migrations or generating seed and sample data by passing
114
- in these flags:
82
+ By default, the installation generator (`rails g spree:install`) will run
83
+ migrations as well as adding seed and sample data. This can be disabled using
115
84
 
116
85
  ```shell
117
86
  rails g spree:install --migrate=false --sample=false --seed=false
118
87
  ```
119
88
 
120
- You can always perform the steps later by using these commands.
89
+ You can always perform any of these steps later by using these commands.
121
90
 
122
91
  ```shell
123
92
  bundle exec rake railties:install:migrations
@@ -126,121 +95,85 @@ bundle exec rake db:seed
126
95
  bundle exec rake spree_sample:load
127
96
  ```
128
97
 
129
- Browse Store
130
- ------------
131
-
132
- http://localhost:nnnn
133
-
134
- Browse Admin Interface
135
- ----------------------
136
-
137
- http://localhost:nnnn/admin
138
-
139
- Working with the edge source (latest and greatest features)
140
- -----------------------------------------------------------
141
-
142
- The source code is essentially a collection of gems. Solidus is meant to be run
143
- within the context of Rails application. You can easily create a sandbox
144
- application inside of your cloned source directory for testing purposes.
145
-
98
+ There are also options and rake tasks provided by
99
+ [solidus\_auth\_devise](https://github.com/solidusio/solidus_auth_devise).
146
100
 
147
- 1. Clone the Git repo
148
-
149
- ```shell
150
- git clone git://github.com/solidusio/solidus.git
151
- cd solidus
152
- ```
153
-
154
- 2. Install the gem dependencies
155
-
156
- ```shell
157
- bundle install
158
- ```
101
+ Performance
102
+ -----------
159
103
 
160
- 3. Create a sandbox Rails application for testing purposes (and automatically
161
- perform all necessary database setup)
104
+ You may notice that your Solidus store runs slowly in development mode. This
105
+ can be because in development each css and javascript is loaded as a separate
106
+ include. This can be disabled by adding the following to
107
+ `config/environments/development.rb`.
162
108
 
163
- ```shell
164
- bundle exec rake sandbox
109
+ ```ruby
110
+ config.assets.debug = false
165
111
  ```
166
112
 
167
- 4. Start the server
113
+ Developing Solidus
114
+ ------------------
168
115
 
169
- ```shell
170
- cd sandbox
171
- rails server
172
- ```
116
+ * Clone the Git repo
173
117
 
174
- Performance
175
- -----------
118
+ ```shell
119
+ git clone git://github.com/solidusio/solidus.git
120
+ cd solidus
121
+ ```
176
122
 
177
- You may notice that your Solidus store runs slowly in development mode. This is
178
- a side-effect of how Rails works in development mode which is to continuously reload
179
- your Ruby objects on each request. The introduction of the asset pipeline in
180
- Rails 3.1 made default performance in development mode significantly worse. There
181
- are, however, a few tricks to speeding up performance in development mode.
123
+ * Install the gem dependencies
182
124
 
183
- First, in your `config/development.rb`:
125
+ ```shell
126
+ bundle install
127
+ ```
184
128
 
185
- ```ruby
186
- config.assets.debug = false
187
- ```
129
+ ### Sandbox
188
130
 
189
- You can precompile your assets as follows:
131
+ Solidus is meant to be run within the context of Rails application. You can
132
+ easily create a sandbox application inside of your cloned source directory for
133
+ testing purposes.
190
134
 
191
- ```shell
192
- RAILS_ENV=development bundle exec rake assets:precompile
193
- ```
135
+ This sandbox includes solidus\_auth\_devise and generates with seed and sample
136
+ data already loaded.
194
137
 
195
- If you want to remove precompiled assets (recommended before you commit to Git
196
- and push your changes) use the following rake task:
138
+ * Create the sandbox application (`DB=mysql` or `DB=postgres` can be specified
139
+ to override the default sqlite)
197
140
 
198
- ```shell
199
- RAILS_ENV=development bundle exec rake assets:clean
200
- ```
141
+ ```shell
142
+ bundle exec rake sandbox
143
+ ```
201
144
 
202
- Use Dedicated Solidus Devise Authentication
203
- -------------------------------------------
204
- Add the following to your Gemfile
145
+ * Start the server
205
146
 
206
- ```ruby
207
- gem 'solidus_auth_devise', github: 'solidusio/solidus_auth_devise'
208
- ```
147
+ ```shell
148
+ cd sandbox
149
+ rails server
150
+ ```
209
151
 
210
- Then run `bundle install`. Authentication will then work exactly as it did in
211
- previous versions of Spree.
152
+ ### Tests
212
153
 
213
- If you're installing this in a new Solidus application, you'll need to install
214
- and run the migrations with
154
+ #### CircleCI
155
+ We use CircleCI to run the tests for Solidus as well as all incoming pull
156
+ requests. All pull requests must pass to be merged.
215
157
 
216
- ```shell
217
- bundle exec rake spree_auth:install:migrations
218
- bundle exec rake db:migrate
219
- ```
158
+ You can see the build statuses at
159
+ [https://circleci.com/gh/solidusio/solidus](https://circleci.com/gh/solidusio/solidus)
220
160
 
221
- change the following line in `config/initializers/spree.rb`
222
- ```ruby
223
- Spree.user_class = 'Spree::LegacyUser'
224
- ```
225
- to
226
- ```ruby
227
- Spree.user_class = 'Spree::User'
228
- ```
161
+ #### Running all tests
229
162
 
230
- In order to set up the admin user for the application you should then run:
163
+ To execute all the tests, run this command at the root of the Solidus project
164
+ to generate test applications and run specs for all projects:
231
165
 
232
166
  ```shell
233
- bundle exec rake spree_auth:admin:create
167
+ bash build.sh
234
168
  ```
235
169
 
236
- Running Tests
237
- -------------
238
-
239
- We use CircleCI to run the tests for Solidus.
170
+ This runs using postgresql by default, but can be overridden by specifying
171
+ `DB=sqlite` or `DB=mysql` in the environment.
240
172
 
241
- You can see the build statuses at [https://circleci.com/gh/solidusio/solidus](https://circleci.com/gh/solidusio/solidus)
173
+ [PhantomJS](http://phantomjs.org/) is required for the frontend and backend
174
+ test suites.
242
175
 
243
- ---
176
+ #### Running an individual test suite
244
177
 
245
178
  Each gem contains its own series of tests, and for each directory, you need to
246
179
  do a quick one-time creation of a test application and then you can use it to run
@@ -257,16 +190,6 @@ dummy apps database, which defaults to sqlite3.
257
190
  DB=postgres bundle exec rake test_app
258
191
  ```
259
192
 
260
- If you want to run specs for only a single spec file
261
- ```shell
262
- bundle exec rspec spec/models/spree/state_spec.rb
263
- ```
264
-
265
- If you want to run a particular line of spec
266
- ```shell
267
- bundle exec rspec spec/models/spree/state_spec.rb:7
268
- ```
269
-
270
193
  You can also enable fail fast in order to stop tests at the first failure
271
194
  ```shell
272
195
  FAIL_FAST=true bundle exec rspec spec/models/state_spec.rb
@@ -277,26 +200,6 @@ If you want to run the simplecov code coverage report
277
200
  COVERAGE=true bundle exec rspec spec
278
201
  ```
279
202
 
280
- If you're working on multiple facets of Solidus to test,
281
- please ensure that you have a postgres user:
282
-
283
- ```shell
284
- createuser -s -r postgres
285
- ```
286
-
287
- And also ensure that you have [PhantomJS](http://phantomjs.org/) installed as well:
288
-
289
- ```shell
290
- brew update && brew install phantomjs
291
- ```
292
-
293
- To execute all the tests, you may want to run this command at the
294
- root of the Solidus project to generate test applications and run
295
- specs for all the facets:
296
- ```shell
297
- bash build.sh
298
- ```
299
-
300
203
  Contributing
301
204
  ------------
302
205
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: solidus
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0.pre
4
+ version: 1.0.0.pre2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Solidus Team
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-06-29 00:00:00.000000000 Z
11
+ date: 2015-07-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: solidus_core
@@ -16,72 +16,71 @@ dependencies:
16
16
  requirements:
17
17
  - - '='
18
18
  - !ruby/object:Gem::Version
19
- version: 1.0.0.pre
19
+ version: 1.0.0.pre2
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - '='
25
25
  - !ruby/object:Gem::Version
26
- version: 1.0.0.pre
26
+ version: 1.0.0.pre2
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: solidus_api
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - '='
32
32
  - !ruby/object:Gem::Version
33
- version: 1.0.0.pre
33
+ version: 1.0.0.pre2
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - '='
39
39
  - !ruby/object:Gem::Version
40
- version: 1.0.0.pre
40
+ version: 1.0.0.pre2
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: solidus_backend
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - '='
46
46
  - !ruby/object:Gem::Version
47
- version: 1.0.0.pre
47
+ version: 1.0.0.pre2
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - '='
53
53
  - !ruby/object:Gem::Version
54
- version: 1.0.0.pre
54
+ version: 1.0.0.pre2
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: solidus_frontend
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
59
  - - '='
60
60
  - !ruby/object:Gem::Version
61
- version: 1.0.0.pre
61
+ version: 1.0.0.pre2
62
62
  type: :runtime
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - '='
67
67
  - !ruby/object:Gem::Version
68
- version: 1.0.0.pre
68
+ version: 1.0.0.pre2
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: solidus_sample
71
71
  requirement: !ruby/object:Gem::Requirement
72
72
  requirements:
73
73
  - - '='
74
74
  - !ruby/object:Gem::Version
75
- version: 1.0.0.pre
75
+ version: 1.0.0.pre2
76
76
  type: :runtime
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
80
  - - '='
81
81
  - !ruby/object:Gem::Version
82
- version: 1.0.0.pre
83
- description: 'Spree is an open source e-commerce framework for Ruby on Rails. Join
84
- us on the spree-user google group or in #spree on IRC'
82
+ version: 1.0.0.pre2
83
+ description: Solidus is an open source e-commerce framework for Ruby on Rails.
85
84
  email: contact@solidus.io
86
85
  executables: []
87
86
  extensions: []
@@ -112,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
112
111
  requirements:
113
112
  - none
114
113
  rubyforge_project:
115
- rubygems_version: 2.2.0
114
+ rubygems_version: 2.4.5
116
115
  signing_key:
117
116
  specification_version: 4
118
117
  summary: Full-stack e-commerce framework for Ruby on Rails.