Merge pull request #1 from DuneSt/development

v1.0.0

.travis.yml

@@ -6,5 +6,13 @@ os:
 - osx
 
 smalltalk:
-  - Pharo-6.0
-  - Pharo-5.0
+  - Pharo-7.0
+  - Pharo-6.1
+  - Pharo64-7.0
+  - Pharo64-6.1
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - smalltalk: Pharo-7.0
+    - smalltalk: Pharo64-7.0

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contribution
+
+This file is currently not complete but will be improve step by step.
+
+# Release management
+
+This project use semantic versionning to define the releases. This mean that each stable release of the project will get associate a version number of the form `vX.Y.Z`. 
+
+- **X** define the major version number
+- **Y** define the minor version number 
+- **Z** define the patch version number
+
+When a release contains only bug fixes, the patch number increase. When the release contains new features backward compatibles, the minor version increase. When the release contains breaking changes, the major version increase. 
+
+Thus, it should be safe to depend on a fixed major version and moving minor version of this project.
+
+# Branch management 
+
+This project use gitflow management.
+
+This project contains two main branches:
+- **master** : This branch is a stable branch. Each version on this branch should be a stable release of Material Design Lite for Seaside, and idealy each commit modifying the source code of the project should be tagged with a version number.
+- **development** : This branch contains the current development of this project. 
+
+## New feature 
+
+When a new feature will take some time to implement, this feature should be developed in a specific branch. Once done, it will be merged in development before the next release of Material Design Lite for Seaside.
+
+## Hot fix
+
+If a bug is found in a stable version and the correction is backward compatible, it should be corrected in an hotfix branch. Once the correction is finished the hotfix branch should be merged into master and development and a new bugfix release should be done.

README.md

@@ -1,12 +1,74 @@
 # Heimdall
 
-####Linux/OSX builds
+#### Linux/OSX builds
 Master: [![Build Status](https://travis-ci.org/DuneSt/Heimdall.svg?branch=master)](https://travis-ci.org/DuneSt/Heimdall)| Development: [![Build Status](https://travis-ci.org/DuneSt/Heimdall.svg?branch=development)](https://travis-ci.org/DuneSt/Heimdall)
 
-####Windows builds
-Master: [![Build status](https://ci.appveyor.com/api/projects/status/bjheqaf3kvxfjk8w/branch/master?svg=true)](https://ci.appveyor.com/project/jecisc/heimdall/branch/master) | Latest commit: [![Build status](https://ci.appveyor.com/api/projects/status/bjheqaf3kvxfjk8w?svg=true)](https://ci.appveyor.com/project/jecisc/heimdall)
+#### Windows builds
+Master: [![Build status](https://ci.appveyor.com/api/projects/status/bjheqaf3kvxfjk8w/branch/master?svg=true)](https://ci.appveyor.com/project/jecisc/heimdall/branch/master) | Development: [![Build status](https://ci.appveyor.com/api/projects/status/bjheqaf3kvxfjk8w/branch/development?svg=true)](https://ci.appveyor.com/project/jecisc/heimdall/branch/development)
 
+Heimdall is a login identification system directly usable for [Seaside](https://github.com/SeasideSt/Seaside). 
+
+For now this is pretty exerimental. 
+
+# Documentation
+
+## Version management 
+
+This project use semantic versionning to define the releases. This mean that each stable release of the project will get associate a version number of the form `vX.Y.Z`. 
+
+- **X** define the major version number
+- **Y** define the minor version number 
+- **Z** define the patch version number
+
+When a release contains only bug fixes, the patch number increase. When the release contains new features backward compatibles, the minor version increase. When the release contains breaking changes, the major version increase. 
+
+Thus, it should be safe to depend on a fixed major version and moving minor version of this project.
+
+## Install Heimdall
+
+To install Heimdall on your Pharo image you can just execute the following script:
+
+```Smalltalk
+    Metacello new
+    	githubUser: 'DuneSt' project: 'Heimdall' commitish: 'v1.x.x' path: 'src';
+    	baseline: 'Heimdall';
+    	onWarningLog;
+		onUpgrade: [ :e | e useIncoming ];
+    	load
+```
+
+To add Heimdall to your baseline just add this:
+
+```Smalltalk
+    spec
+    	baseline: 'Heimdall'
+    	with: [ spec repository: 'github://DuneSt/Heimdall:v1.x.x/src' ]
+```
+
+Note that you can replace the v1.x.x tag by a branch as #master or #development or a tag as #v1.0.0, #v1.? or #v1.0.x or a commit SHA.
+
+## Getting started 
+
+The first thing to do in order to use Heimdall is to add its `FileLibrary` to your Seaside application and use the Heimdall session.
+
+```Smalltalk
+	| app |
+	app := WAAdmin register: self asApplicationAt: 'myApplication'.
+	app preferenceAt: #sessionClass put: HeimdallSession.
+	app
+		addLibrary: HeimdallFileLibrary;
+		addLibrary: JQDeploymentLibrary
+```
+
+## Smalltalk versions compatibility
+
+| Heimdall version 	| Compatible Pharo versions 	|
+|------------------	|---------------------------	|
+| v1.0.0	   		| Pharo 61                  	|
+| development      	| Pharo 61                  	|
+
+## Contact
+
+If you have any question or problem do not hesitate to open an issue or contact cyril (a) ferlicot.me or guillaume.larcheveque (a) gmail.com
 
-Heimdall is a login identification system directly usable for seaside. 
 
-For now this is exerimental stuff and it will need a good cleaning. 

appveyor.yml

@@ -6,8 +6,12 @@ environment:
   CYG_MIRROR: http://cygwin.mirror.constant.com
   SCI_RUN: /cygdrive/c/smalltalkCI-master/run.sh
   matrix:
-    - SMALLTALK: Pharo-6.0
-    - SMALLTALK: Pharo-5.0
+    - SMALLTALK: Pharo-7.0
+    - SMALLTALK: Pharo-6.1
+
+matrix:
+  allow_failures:
+    - SMALLTALK: Pharo-7.0
 
 platform:
   - x86

src/.properties

@@ -0,0 +1,3 @@
+{
+	#format : #tonel
+}

src/BaselineOfHeimdall/BaselineOfHeimdall.class.st

@@ -0,0 +1,43 @@
+Class {
+	#name : #BaselineOfHeimdall,
+	#superclass : #BaselineOf,
+	#category : 'BaselineOfHeimdall'
+}
+
+{ #category : #baseline }
+BaselineOfHeimdall >> baseline: spec [
+	<baseline>
+	spec
+		for: #common
+		do: [ 
+			"Dependencies"
+			self seaside3: spec.
+
+			"Packages"
+			spec
+				package: #'Heimdall-Core';
+				package: #'Heimdall-Core-Tests' with: [ spec requires: #('Heimdall-Core') ];
+				package: #'Heimdall-Seaside' with: [ spec requires: #('Heimdall-Core' 'Seaside3') ].
+
+			"Groups"
+			spec
+				group: 'minimal' with: #(#'Heimdall-Core');
+				group: 'seaside' with: #(#'Heimdall-Seaside');
+				group: 'tests' with: #(#'Heimdall-Core-Tests') ]
+]
+
+{ #category : #accessing }
+BaselineOfHeimdall >> projectClass [
+	^ [ self class environment at: #MetacelloCypressBaselineProject ]
+		on: NotFound
+		do: [ super projectClass ]
+]
+
+{ #category : #dependencies }
+BaselineOfHeimdall >> seaside3: spec [
+	spec
+		baseline: 'Seaside3'
+		with: [ spec
+				loads: #('Core');
+				repository: 'github://SeasideSt/Seaside/repository' ]
+]

src/BaselineOfHeimdall/package.st

@@ -0,0 +1 @@
+Package { #name : #BaselineOfHeimdall }

src/Heimdall-Core-Tests/TranslateTextTest.class.st

@@ -0,0 +1,44 @@
+"
+A TranslateTextTest is a test class for testing the behavior of TranslateText
+"
+Class {
+	#name : #TranslateTextTest,
+	#superclass : #TestCase,
+	#category : 'Heimdall-Core-Tests'
+}
+
+{ #category : #tests }
+TranslateTextTest >> testEnglishText [
+	| text |
+	text := 'English' french: 'French'.
+	self assert: text englishText equals: 'English'
+]
+
+{ #category : #tests }
+TranslateTextTest >> testEquals [
+	| inst1 inst2 |
+	inst1 := 'English' french: 'French'.
+	inst2 := 'English' french: 'French'.
+	self assert: inst1 equals: inst2.
+
+	inst2 := 'English2' french: 'French'.
+	self deny: inst1 = inst2.
+
+	inst2 := 'English' french: 'French2'.
+	self deny: inst1 = inst2
+]
+
+{ #category : #tests }
+TranslateTextTest >> testFrenchText [
+	| text |
+	text := 'English' french: 'French'.
+	self assert: text frenchText equals: 'French'
+]
+
+{ #category : #tests }
+TranslateTextTest >> testInto [
+	| text |
+	text := 'English' french: 'French'.
+	self assert: (text into: #french) equals: 'French'.
+	self assert: (text into: #english) equals: 'English'
+]

src/Heimdall-Core-Tests/package.st

@@ -0,0 +1 @@
+Package { #name : #'Heimdall-Core-Tests' }